Powershell: Ninja-Property-Docs-Get

Argomento

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

Se si utilizza il modulo NinjaOne PowerShell al di fuori di uno script di automazione, potrebbe essere necessario modificare la politica di esecuzione di PowerShell. Per ulteriori 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 recupera il valore di un campo personalizzato specificato in un documento. È possibile specificare il nome del campo utilizzando il parametro -AttributeName, il documento utilizzando il parametro -DocumentName e il modello del documento utilizzando il parametro -TemplateId. Il cmdlet restituisce il valore corrente del campo personalizzato nel documento specificato.

Sintassi

Ninja-Property-Docs-Get [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName]<Object>] [<CommonParameters>]

Esempio

Recupero di un valore da un documento

PS C:> Ninja-Property-Docs-Get -TemplateId "12345" -DocumentName "My
Example Document" -AttributeName "exampleAttribute"
Riga 1
Riga 3

Il valore del campo personalizzato "exampleAttribute" nel documento "My Example Document" viene recuperato e visualizzato nell’output. In questo esempio, il campo personalizzato contiene più righe di testo.

Parametri

-AttributeName

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

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

-DocumentName

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

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

-TemplateId

Specificare l’ID del modello di documento contenente il documento e il campo personalizzato che si desidera recuperare tramite
.

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

Input

System.String

Questo cmdlet non accetta input dalla pipeline. I parametri -AttributeName, -DocumentName e -TemplateId accettano valori di tipo stringa che rappresentano, rispettivamente, il nome del campo personalizzato da recuperare, il nome del documento e l'ID del modello di documento.

Uscite

System.String[]

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

Con questo cmdlet è possibile recuperare solo i campi del documento con autorizzazioni di lettura per l’automazione. Per informazioni sulle autorizzazioni relative ai campi personalizzati, consultare NinjaOne Custom Fields: Getting Started.

Risorse aggiuntive

Per ulteriori informazioni sulla gestione delle risorse e sugli script personalizzati, consultare le seguenti risorse: