PowerShell : Ninja-Property-Docs-Get-Single

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Get-Single pourrécupérer la valeur d'un champ personnalisé spécifié dans un document unique.

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

La cmdlet Ninja-Property-Docs-Get-Single récupère la valeur d’un champ personnalisé spécifié dans un document unique. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName et le document à l’aide du paramètre -TemplateName. La cmdlet renvoie la valeur actuelle du champ personnalisé dans le document unique spécifié.

Seuls les champs de document disposant d’autorisations de lecture en automatisation peuvent être récupérés à l’aide de cette cmdlet.

Syntaxe

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

Exemple

Récupérer une valeur dans un document unique

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

La valeur du champ personnalisé « exampleAttribute » dans le document « My Example Document » est récupérée et affichée dans la sortie.

Paramètres

-AttributeName

Spécifiez le nom du champ personnalisé que vous souhaitez récupérer dans le document.

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é que vous souhaitez récupérer.

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

Entrées

System.String

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

Sorties

System.String[]

La cmdlet renvoie la valeur du champ personnalisé spécifié dans le document unique indiqué sous la forme d’une chaîne de caractères ou d’un tableau de chaînes de caractères si le champ comporte plusieurs lignes.

Seuls les champs de document disposant d’autorisations de lecture en mode automatisé peuvent être récupérés à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la documentation « 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 :