PowerShell : Ninja-Property-Docs-Noms

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Names pour récupérer l'ID ou le nom des documents associés à un ID de modèle.

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-Names récupère l’ID ou le nom des documents associés à un ID de modèle. Vous pouvez spécifier le modèle de document à l’aide du paramètre -TemplateId. La cmdlet renvoie l’ID ou le nom du ou des documents associés à l’ID de modèle spécifié au format <id>=<name>.

Syntaxe

Ninja-Property-Docs-Names [[-TemplateId] <Object>] [<CommonParameters>]

Exemples

Exemple 1 : liste des pages

PS C:> Ninja-Property-Docs-Names -TemplateId "11"
10=Document 1
11=Document 2

Lorsqu'un modèle de document contient plusieurs documents, la cmdlet renvoie l'ID et le nom d'
ion de chaque document associé au format <id>=<name>.

Exemple 2 : document unique

PS C:> Ninja-Property-Docs-Names -TemplateId "4"
5=Accès à distance

Lorsqu’un seul document est associé à un modèle de document, la cmdlet renvoie l’ID, l’
et le nom de ce document uniquement, au format <id>=<name>.

Paramètres

TemplateId

Spécifiez l'ID du modèle de document contenant les documents 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. Le paramètre -TemplateId accepte des valeurs de type chaîne de caractères représentant l'ID du modèle de document contenant les documents que vous souhaitez récupérer.

Sorties

System.String[]

La cmdlet renvoie l’ID et le nom du ou des documents associés à l’ID de modèle spécifié au format <id>=<name> sous forme de chaîne de caractères ou de tableau de chaînes de caractères si plusieurs documents sont associés au modèle.

Des autorisations de lecture en mode automatisé sont requises pour récupérer toute valeur de champ personnalisé. 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 ressources et les scripts personnalisés, consultez les ressources suivantes :