PowerShell : Ninja-Property-Docs-Get

Sujet

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

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

Environnement

NinjaOne
Microsoft PowerShell

Description

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

Syntaxe

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

Exemple

Récupérer une valeur dans un document

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

La valeur du champ personnalisé « exampleAttribute » dans le document « My Example Document » est récupérée et affichée dans la sortie. Dans cet exemple, le champ personnalisé contient plusieurs lignes de texte.

Paramètres

-AttributeName

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

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

-DocumentName

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

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

-TemplateId

Spécifiez l'ID du modèle de document contenant le document et le champ personnalisé que vous souhaitez récupérer à l'aide de «
».

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, -DocumentName et -TemplateId acceptent des valeurs de type chaîne représentant respectivement le nom du champ personnalisé à récupérer, le nom du document et l’ID du modèle de document.

Sorties

System.String[]

La cmdlet renvoie la valeur du champ personnalisé spécifié dans le document indiqué sous la forme d'une chaîne de caractères de type «
» 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 pour l’automatisation 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 section « NinjaOne Custom Fields: Getting Started ».

Ressources supplémentaires

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