dsc-Konfigurationsexport

Zusammenfassung

Generiert ein Konfigurationsdokument, das die vorhandenen Instanzen einer Gruppe von Ressourcen definiert.

Syntax

Konfigurationsdokument aus stdin

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

Konfigurationsdokument aus Optionszeichenfolge

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

Konfigurationsdokument aus Datei

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

BESCHREIBUNG

Der export Unterbefehl generiert ein Konfigurationsdokument, das alle instance einer Gruppe von Ressourcen enthält.

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

Die Eingabekonfiguration definiert die zu exportierenden Ressourcen. DSC ignoriert alle Eigenschaften, die für die Ressourcen in der Eingabekonfiguration für den Vorgang angegeben sind, aber das Eingabedokument und alle Eigenschaften für Ressourceninstanzen müssen weiterhin anhand des Konfigurationsdokuments und der Ressourcen instance Schemas überprüft werden.

Geben Sie nur Ressourcen mit einem Ressourcenmanifest an, das den Exportabschnitt in der Eingabekonfiguration definiert. Definieren Sie jeden Ressourcentyp nur einmal. Wenn das Konfigurationsdokument eine Ressource instance enthält, bei der der Ressourcentyp nicht exportierbar ist oder bereits in der Konfiguration deklariert wurde, löst DSC einen Fehler aus.

Optionen

-d, --document

Gibt das Konfigurationsdokument an, aus dem als JSON- oder YAML-Objekt exportiert werden soll. 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 mit der --path Option verwendet werden. Wählen Sie aus, ob das Konfigurationsdokument über stdin, aus einer Datei mit der Option oder mit der --path Option an den --document Befehl übergeben werden soll.

Type:      String
Mandatory: false

-p, --path

Definiert den Pfad zu einem zu exportierenden Konfigurationsdokument, anstatt das Dokument aus stdin zu übergeben 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 ein Konfigurationsdokument einschließlich aller instance der in der Eingabekonfiguration deklarierten Ressourcen definiert. Weitere Informationen finden Sie unter Referenz zu DSC-Konfigurationsdokumentschemas.