Powershell: Ninja-Property-Docs-Opzioni

Argomento

Questo articolo spiega come utilizzare Ninja-Property-Docs-Optionsper recuperare valori validi per un campo personalizzato a discesa o a selezione multipla in un 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 ulteriori informazioni sulle politiche di esecuzione, consultare la documentazione di Microsoft: Informazioni sulle politiche di esecuzione ( link esterno).

Ambiente

NinjaOne
Microsoft PowerShell

Descrizione

Questo cmdlet recupera i valori validi per un campo personalizzato a menu a tendina o a selezione multipla 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 un elenco di opzioni valide nel formato <guid>=<name>, dove <guid> è l'identificatore univoco dell'opzione e <name> è il nome visualizzato dell'opzione. È possibile recuperare le opzioni tramite questo cmdlet solo per i campi del documento con autorizzazioni di lettura per l'automazione.

Sintassi

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

Esempi

Esempio 1: un campo personalizzato a discesa

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Il mio
documento di esempio" -AttributeName "exampleDropdown"
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Opzione di esempio 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Opzione di esempio 2
61010919-654f-4448-ba15-48a160d42f44=Cinese semplificato
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Esempio opzione 1

Quando viene specificato un campo personalizzato a menu a discesa, il cmdlet restituisce le opzioni valide per il campo a menu a discesa
nel formato <guid>=<name>, dove <guid> è l'identificatore univoco dell'opzione
e <name> è il nome visualizzato dell'opzione.

Esempio 2: un campo personalizzato a selezione multipla

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "My
Example Document" -AttributeName "exampleMultiSelect"
1e6bcc4a-0272-414e-a77c-4109ef79f86e=Opzione 1
3e08d167-e830-41e7-ae8f-1128e22b00a9=Opzione 3
4f4f73ba-0d69-4518-a78b-9ca554471b8e=Opzione 2
680e655d-0b66-4dba-a96e-dcee77ddd1e4=Cinese semplificato

Quando viene specificato un campo personalizzato a selezione multipla, il cmdlet restituisce le opzioni valide per il campo a selezione multipla
nel formato <guid>=<name>, dove <guid> è l'identificatore univoco dell'opzione
e <name> è il nome visualizzato dell'opzione.

Esempio 3: un campo personalizzato senza opzioni

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "My
Example Document" -AttributeName "exampleTextField"

Quando viene specificato un campo personalizzato privo di opzioni, come ad esempio un campo di testo, il cmdlet non restituisce alcun output.

Parametri

-AttributeName

Specificare il nome del campo personalizzato per il quale si desidera recuperare le opzioni valide.

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 per il quale si desidera recuperare le opzioni valide c
.

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 il nome del modello di documento contenente il campo personalizzato per il quale si desidera recuperare le opzioni valide dell'
.

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

Il cmdlet non accetta input dalla pipeline. I parametri -TemplateId, -DocumentName e -AttributeName accettano valori di tipo stringa che rappresentano, rispettivamente, l'ID del modello di documento, il nome del documento e il nome del campo personalizzato per i quali si desidera recuperare le opzioni valide.

Uscite

System.String[]

Il cmdlet restituisce le opzioni valide per il campo personalizzato specificato nel documento specificato nel formato <guid>=<name> come stringa o come array di stringhe se è disponibile più di un'opzione.

Questo cmdlet è applicabile solo ai campi personalizzati a menu a tendina e a selezione multipla. Se viene specificato un tipo di campo personalizzato
diverso, non verrà restituito alcun risultato.
È possibile recuperare le opzioni solo per i campi del documento con autorizzazioni di lettura per l’automazione utilizzando questo cmdlet. 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: