Powershell: Ninja-Property-Docs-Get-Single

Argomento

Questo articolo spiega come utilizzare Ninja-Property-Docs-Get-Single perrecuperare il valore di un campo personalizzato specificato in un singolo documento.

Se si utilizza il modulo PowerShell di NinjaOne al di fuori di uno script di automazione, potrebbe essere necessario modificare la politica di esecuzione di PowerShell. Per altre informazioni sulle politiche di esecuzione, consultare la documentazione di Microsoft: Informazioni sulle politiche di esecuzione ( link esterno).

Ambiente

NinjaOne
Microsoft Powershell

Descrizione

Il cmdlet Ninja-Property-Docs-Get-Single recupera il valore di un campo personalizzato specificato in un singolo documento. È possibile specificare il nome del campo utilizzando il parametro -AttributeName e il documento utilizzando il parametro -TemplateName. Il cmdlet restituisce il valore corrente del campo personalizzato nel singolo documento specificato.

Con questo cmdlet è possibile recuperare solo i campi documento con autorizzazioni di lettura per l'automazione.

Sintassi

Ninja-Property-Docs-Get-Single [[-TemplateName] <OBJECT>] [[-AttributeName] <OBJECT>][<COMMONPARAMETERS>]

Esempio

Recuperare un valore da un singolo documento

PS C:> Ninja-Property-Docs-Get-Single -TemplateName "My Example Document" -
AttributeName "exampleAttribute"
Mötley Crüe

Il valore del campo personalizzato "exampleAttribute" nel singolo documento "My Example Document" viene recuperato e visualizzato nell'output.

Parametri

-AttributeName

Specifica il nome del campo personalizzato che si desidera recuperare dal documento.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 1
Valore predefinito: Nessuno
Accetta input dalla pipeline: Falso
Accetta caratteri jolly: Falso

-TemplateName

Specificare il nome del singolo documento contenente il campo personalizzato che si desidera recuperare.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 0
Valore predefinito: Nessuno
Accetta input dalla pipeline: Falso
Accetta caratteri jolly: Falso

Input

Il sistema.String

Questo cmdlet non accetta input dalla pipeline. I parametri -AttributeName e -
TemplateName accettano valori stringa che rappresentano, rispettivamente, il nome del campo personalizzato da recuperare
e il nome del singolo documento.

Uscite

System.String[]

Il cmdlet restituisce il valore del campo personalizzato specificato nel singolo documento specificato come stringa o come array di stringhe se è presente più di una riga.

Solo i campi documento con autorizzazioni di lettura per l’automazione possono essere recuperati utilizzando questo cmdlet. Per informazioni sulle autorizzazioni relative ai campi personalizzati, consultare NinjaOne Custom Fields: Inizia.

Risorse aggiuntive

Per altre informazioni sulla gestione delle risorse e sulla creazione di script personalizzati, consultare le seguenti risorse: