dsc config get

Artikel
06/24/2024

Zusammenfassung

Ruft den aktuellen Status von Ressourceninstanzen in einem Konfigurationsdokument ab.

Syntax

Konfigurationsdokument aus stdin

<document-string> | dsc config get [Options]

Konfigurationsdokument aus Optionszeichenfolge

dsc config get [Options] --document <document-string>

Konfigurationsdokument aus Datei

dsc config get [Options] --path <document-filepath>

BESCHREIBUNG

Der get Unterbefehl gibt den aktuellen Zustand der Ressourceninstanzen in einem Konfigurationsdokument zurück. Wenn dieser Befehl ausgeführt wird, überprüft DSC das Konfigurationsdokument, bevor der Get-Vorgang für jede im Dokument definierte Ressource instance aufgerufen wird.

Das Konfigurationsdokument muss als JSON oder YAML über stdin, als Zeichenfolge mit der Dokumentoption oder aus einer Datei mit der Option pfad an diesen Befehl übergeben werden.

Beispiele

Beispiel 1: Abrufen des aktuellen Zustands der Ressourceninstanzen einer Konfiguration

Der Befehl gibt den tatsächlichen Zustand für die Ressourceninstanzen zurück, die im Konfigurationsdokument definiert sind, das als example.dsc.config.yamlgespeichert ist.

# example.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config get

Beispiel 2: Übergeben einer Datei, die als Konfigurationsdokument gelesen werden soll

Der Befehl verwendet die Pfadoption , um die in der example.dsc.config.yaml Datei definierten Ressourceninstanzen abzurufen.

dsc config get --path ./example.dsc.config.yaml

Beispiel 3: Übergeben eines Konfigurationsdokuments als Variable

Der Befehl verwendet die Dokumentoption , um die in einem in der $desired Variablen gespeicherten Konfigurationsdokument definierten Ressourceninstanzen abzurufen.

dsc config get --document $desired

Optionen

-d, --document

Gibt das Konfigurationsdokument an, für das der tatsächliche Zustand abgerufen werden soll. Das Dokument muss eine Zeichenfolge sein, die ein JSON- oder YAML-Objekt enthält. DSC überprüft das Dokument anhand des Konfigurationsdokumentschemas. Wenn die Überprüfung fehlschlägt, löst DSC einen Fehler aus.

Diese Option kann nicht mit dem Konfigurationsdokument über stdin oder der --path Option verwendet werden. Wählen Sie aus, ob das Konfigurationsdokument über stdin, aus einer Datei mit der --path Option oder mit der Option an den --document Befehl übergeben werden soll.

Type:      String
Mandatory: false

-p, --path

Definiert den Pfad zu einem Konfigurationsdokument, für das der tatsächliche Zustand abgerufen werden soll, anstatt das Dokument aus stdin zu leiten oder es als Zeichenfolge mit der --document Option zu übergeben. Die angegebene Datei muss ein Konfigurationsdokument als JSON- oder YAML-Objekt enthalten. DSC überprüft das Dokument anhand des Konfigurationsdokumentschemas. 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 --document Option gegenseitig aus. Wenn Sie diese Option verwenden, ignoriert DSC alle Eingaben von stdin.

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

Dieser Befehl gibt eine JSON-Ausgabe zurück, die enthält, ob der Vorgang oder Ressourcen Fehler ausgelöst haben, die Sammlung von Meldungen, die während des Vorgangs ausgegeben werden, und die Ergebnisse des Get-Vorgangs für jede instance. Weitere Informationen finden Sie unter dsc config get result schema.

Freigeben über