Powershell: Ninja-Property-Docs-Get-Single

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Get-Single“den Wert eines bestimmten benutzerdefinierten Feldes in einem einzelnen Dokument abrufen können.

Wenn Sie das NinjaOne-PowerShell-Modul außerhalb eines Automatisierungsskripts verwenden, müssen Sie möglicherweise die Ausführungsrichtlinie von PowerShell anpassen. Weitere Informationen zu Ausführungsrichtlinien finden Sie in der Dokumentation von Microsoft: Über Ausführungsrichtlinien ( externer Link).

Umgebung

NinjaOne
Microsoft PowerShell

Beschreibung

Das Cmdlet „Ninja-Property-Docs-Get-Single“ ruft den Wert eines angegebenen benutzerdefinierten Feldes in einem einzelnen Dokument ab. Sie können den Feldnamen mit dem Parameter „-AttributeName“ und das Dokument mit dem Parameter „-TemplateName“ angeben. Das Cmdlet gibt den aktuellen Wert des benutzerdefinierten Feldes in dem angegebenen einzelnen Dokument zurück.

Mit diesem Cmdlet können nur Dokumentfelder abgerufen werden, für die Lesezugriffsrechte für die Automatisierung bestehen.

Syntax

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

Beispiel

Einen Wert aus einem einzelnen Dokument abrufen

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

Der Wert des benutzerdefinierten Felds „exampleAttribute“ im einzelnen Dokument „My Example Document“ wird abgerufen und in der Ausgabe angezeigt.

Parameter

-AttributeName

Geben Sie den Namen des benutzerdefinierten Feldes an, das Sie aus dem Dokument abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 1
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-TemplateName

Geben Sie den Namen des einzelnen Dokuments an, das das benutzerdefinierte Feld enthält, das Sie abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 0
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

Eingaben

System.String

Dieses Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter „-AttributeName“ und „-
TemplateName“ akzeptieren Zeichenfolgenwerte, die den Namen des benutzerdefinierten Felds, das abgerufen werden soll (
), bzw. den Namen des einzelnen Dokuments darstellen.

Ausgaben

System.String[]

Das Cmdlet gibt den Wert des angegebenen benutzerdefinierten Feldes im angegebenen einzelnen Dokument als Zeichenfolge oder als Array von Zeichenfolgen zurück, falls mehr als eine Zeile vorhanden ist.

Mit diesem Cmdlet können nur Dokumentfelder abgerufen werden, für die Lesezugriffsrechte für die Automatisierung bestehen. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.

Weitere Ressourcen

Weitere Informationen zur Asset-Verwaltung und zur Erstellung benutzerdefinierter Skripte finden Sie in den folgenden Ressourcen: