dsc resource get

  • Artikel

Zusammenfassung

Ruft den Get-Vorgang einer Ressource auf.

Syntax

Ohne instance Eigenschaften

dsc resource get [Options] --resource <RESOURCE>

Instanzeigenschaften aus stdin

<instance-properties> | dsc resource get [Options] --resource <RESOURCE>

Instanzeigenschaften aus Eingabeoption

dsc resource get --input '<instance-properties>' --resource <RESOURCE>

Instanzeigenschaften aus der Datei

dsc resource get --path <instance-properties-filepath> --resource <RESOURCE>

BESCHREIBUNG

Der get Unterbefehl gibt den aktuellen Zustand einer Ressource instance zurück.

Standardmäßig gibt dieser Unterbefehl einen instance aus einer bestimmten DSC-Ressource zurück. Um mehrere Ressourcen zurückzugeben, verwenden Sie den --all Parameter, eine Ressourcengruppe oder den Befehl dsc config get .

Alle Eigenschaften, die die Ressource zum Abrufen des Zustands einer instance benötigt, müssen als JSON- oder YAML-Objekt an diesen Befehl übergeben werden. Das Objekt kann von stdin oder mit der --input Option an diesen Befehl übergeben werden. Sie können die --path Option auch verwenden, um das Objekt aus einer JSON- oder YAML-Datei zu lesen.

Beispiele

Beispiel 1: Abrufen von ressourcenbasierten instance ohne Eingabe

Für Ressourcen mit einer instance, für die keine Eigenschaftswerte erforderlich sind, um den tatsächlichen Zustand der Ressource instance zurückzugeben, sind die instance Eigenschaften nicht erforderlich.

dsc resource get --resource Microsoft/OSInfo

actualState:
  $id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
  family: Windows
  version: 10.0.22621
  edition: Windows 11 Enterprise
  bitness: '64'

Beispiel 2: Abrufen einer Ressource instance mit Eingabeoption

Wenn eine Ressource einen oder mehrere Eigenschaftswerte erfordert, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften mit der Eingabeoption entweder als JSON oder YAML übergeben werden.

dsc resource get --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}'

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Beispiel 3: Abrufen einer Ressource instance mit Eingabe von stdin

Wenn eine Ressource mindestens einen Eigenschaftswert benötigt, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften als JSON oder YAML über stdin übergeben werden.

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Beispiel 4: Abrufen von Ressourcen instance mit Eingabe aus einer YAML-Datei

Wenn eine Ressource einen oder mehrere Eigenschaftswerte erfordert, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften aus einer gespeicherten JSON- oder YAML-Datei abgerufen werden.

cat ./example.yaml

keyPath:   HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot

dsc resource get --resource Microsoft.Windows/Registry --path ./example.yaml

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Optionen

-a, --all

Gibt an, dass der Befehl jede instance der angegebenen DSC-Ressource anstelle eines bestimmten instance zurückgeben soll.

Diese Option ist nur gültig, wenn die Ressource eine exportierbare Ressource ist, die den Exportabschnitt in der Eingabekonfiguration definiert. Wenn der Ressourcentyp nicht exportiert werden kann, löst DSC einen Fehler aus.

Wenn diese Option angegeben ist, ignoriert DSC die --input Optionen und --path sowie alle JSON- oder YAML-Optionen, die von stdin an den Befehl gesendet werden.

Type:      Boolean
Mandatory: false

-r, --resource

Gibt den vollqualifizierten Typnamen der zu verwendenden DSC-Ressource an, z. B Microsoft.Windows/Registry. .

Die vollqualifizierte Typnamensyntax lautet: <owner>[.<group>][.<area>]/<name>, wobei:

  • Der owner ist der Verwalten des Autors oder organization für die Ressource.
  • Die group und area sind optionale Namenskomponenten, die die Namenspacing für eine Ressource ermöglichen.
  • Der name identifiziert die Komponente, die von der Ressource verwaltet wird.
Type:      String
Mandatory: true

-i, --input

Gibt ein JSON- oder YAML-Objekt mit den Eigenschaften an, die zum Abrufen einer instance der DSC-Ressource erforderlich sind. DSC überprüft das Objekt anhand des instance Schemas der Ressource. Wenn die Überprüfung fehlschlägt, löst DSC einen Fehler aus.

Diese Option kann nicht mit instance Eigenschaften über stdin oder die --path Option verwendet werden. Wählen Sie aus, ob die instance Eigenschaften über stdin, aus einer Datei mit der --path Option oder mit der Option an den --input Befehl übergeben werden sollen.

DSC ignoriert diese Option, wenn die --all Option angegeben wird.

Type:      String
Mandatory: false

-p, --path

Definiert den Pfad zu einer Textdatei, die als Eingabe für den Befehl gelesen werden soll, anstatt eingaben von stdin oder als Zeichenfolge mit der --input Option zu übergeben. Die angegebene Datei muss JSON oder YAML enthalten, das gültige Eigenschaften für die Ressource darstellt. DSC überprüft das Objekt anhand des instance Schemas der Ressource. Wenn die Überprüfung fehlschlägt oder die angegebene Datei nicht vorhanden ist, löst DSC einen Fehler aus.

Diese Option schließt sich mit der --input Option gegenseitig aus. Wenn Sie diese Option verwenden, ignoriert DSC alle Eingaben von stdin.

DSC ignoriert diese Option, wenn die --all Option angegeben wird.

Type:      String
Mandatory: false

-f, --format

Die --format Option steuert das Konsolenausgabeformat für den Befehl. Wenn die Befehlsausgabe umgeleitet oder als Variable erfasst wird, ist die Ausgabe immer JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Zeigt die Hilfe für den aktuellen Befehl oder Unterbefehl an. Wenn Sie diese Option angeben, ignoriert die Anwendung alle Optionen und Argumente nach dieser Option.

Type:      Boolean
Mandatory: false

Ausgabe

Standardmäßig gibt dieser Befehl eine JSON-Ausgabe zurück, die den tatsächlichen Zustand des instance enthält. Wenn die --all Option angegeben ist, gibt der Befehl die JSON-Ausgabe für jede instance als JSON-Zeilen zurück.

Weitere Informationen zur Struktur des Ausgabe-JSON finden Sie unter dsc-Ressourcenergebnisschema.