PowerShell : Ninja-Property-Docs-Options-Single

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Options-Singlepour récupérer les valeurs valides d'un champ personnalisé de type liste déroulante ou sélection multiple dans un seul document.

Si vous utilisez le module PowerShell NinjaOne en dehors d'un script d'automatisation, vous devrez peut-être ajuster la politique d'exécution de PowerShell. Pour plus d'informations sur les politiques d'exécution, consultez la documentation de Microsoft : À propos des politiques d'exécution ( lien externe).

Environnement

NinjaOne
Microsoft PowerShell

Description

Cette cmdlet récupère les valeurs valides d’un champ personnalisé de type liste déroulante ou sélection multiple dans un document unique. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName et celui du document à l’aide du paramètre -TemplateName. La cmdlet renvoie une liste des options valides au format <guid>=<name>, où <guid> est l’identifiant unique de l’option et <name> son nom d’affichage. Seuls les champs de document disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet.

Syntaxe

Ninja-Property-Docs-Options-Single [[-TemplateName] <Object>] [[-AttributeName] <Object>] [<CommonParameters>]

Exemples

Exemple 1 : un champ personnalisé de type liste déroulante

PS C:> Ninja-Property-Docs-Options-Single -TemplateName "Mon exemple
de document" -AttributeName "exampleDropdown"
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Exemple d'option 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Exemple d’option 2
61010919-654f-4448-ba15-48a160d42f44=Chinois simplifié
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Exemple d'option 1

Lorsqu'un champ personnalisé de type liste déroulante est spécifié, la cmdlet renvoie les options valides pour ce champ au format <guid>=<name>, où <guid> est l'identifiant unique de l'option et <name> est le nom d'affichage de l'option.

Exemple 2 : un champ personnalisé à sélection multiple

PS C:> Ninja-Property-Docs-Options-Single -TemplateName "Mon exemple
de document" -AttributeName "exampleMultiSelect"
1e6bcc4a-0272-414e-a77c-4109ef79f86e=Option 1
3e08d167-e830-41e7-ae8f-1128e22b00a9=Option 3
4f4f73ba-0d69-4518-a78b-9ca554471b8e=Option 2
680e655d-0b66-4dba-a96e-dcee77ddd1e4=Chinois simplifié

Lorsqu'un champ personnalisé à sélection multiple est spécifié, la cmdlet renvoie les options valides pour ce champ au format <guid>=<name>, où <guid> est l'identifiant unique de l'option et <name> est le nom d'affichage de l'option.

Exemple 3 : un champ personnalisé sans options

PS C:> Ninja-Property-Docs-Options-Single -TemplateName "My Example
Document" -AttributeName "exampleTextField"

Lorsqu’un champ personnalisé ne comportant pas d’options, tel qu’un champ de texte, est spécifié, la cmdlet ne renvoie aucun résultat.

Paramètres

-AttributeName

Spécifiez le nom du champ personnalisé pour lequel vous souhaitez récupérer les options valides.

Type : Objet
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 1
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

-TemplateName

Spécifiez le nom du document unique contenant le champ personnalisé pour lequel vous souhaitez récupérer les options valides.

Type : Objet
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 0
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Faux
Accepte les caractères génériques : Faux

Entrées

System.String

La cmdlet n'accepte pas d'entrée provenant du pipeline. Les paramètres -TemplateName et -AttributeName acceptent des valeurs de type chaîne représentant respectivement le nom du document unique et le nom du champ personnalisé pour lesquels vous souhaitez récupérer les options valides.

Sorties

System.String[]

La cmdlet renvoie les options valides pour le champ personnalisé spécifié dans le document unique indiqué, au format <guid>=<name> sous forme de chaîne de caractères ou de tableau de chaînes si plusieurs options sont disponibles.

Cette cmdlet s’applique uniquement aux champs personnalisés de type liste déroulante et sélection multiple. Si un autre type de champ personnalisé
est spécifié, aucune sortie ne sera renvoyée.
Seuls les champs de document disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « NinjaOne Custom Fields : Getting Started ».

Ressources supplémentaires

Pour plus d’informations sur la gestion des actifs et les scripts personnalisés, consultez les ressources suivantes :