PowerShell : Ninja-Property-Docs-Noms

Rubrique

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

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-Names récupère l'ID ou le nom des documents associés à un identifiant 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'identifiant de modèle spécifié au format <ID>=<NAME>.

Syntaxe

Ninja-Property-Docs-Noms [[-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'
de chaque document associé au format <ID>=<NOM>.

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,
et le nom de ce document uniquement, au format <ID>=<NOM>.

Paramètres

TemplateId

Spécifiez l'ID du modèle de document contenant les documents que vous souhaitez récupérer.

Type : Objet
Jeux 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

Le Système.String

Cette cmdlet n’accepte pas d’entrée provenant du pipeline. Le paramètre -TemplateId accepte des valeurs de chaîne représentant l’ID du modèle de document contenant les documents que vous souhaitez récupérer.

Sorties

Le Système.String[]

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

Des autorisations de lecture en mode d’automatisation sont requises pour récupérer n’importe quelle valeur du champ personnalisé. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « NinjaOne Custom Fields : Getting Started ».

Ressources complémentaires

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