dsc 構成のエクスポート

概要

一連のリソースの既存のインスタンスを定義する構成ドキュメントを生成します。

構文

stdin からの構成ドキュメント

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

オプション文字列からの構成ドキュメント

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

ファイルからの構成ドキュメント

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

説明

サブコマンドは export 、一連のリソースのすべてのインスタンスを含む構成ドキュメントを生成します。

構成ドキュメントは、stdin 経由で JSON または YAML として、 ドキュメント オプションを含む文字列として、または パス オプションを持つファイルからこのコマンドに渡す必要があります。

入力構成では、エクスポートするリソースを定義します。 DSC では、操作の入力構成でリソースに対して指定されたプロパティは無視されますが、入力ドキュメントとリソース インスタンスのプロパティは、構成ドキュメントとリソース インスタンス スキーマに対して検証する必要があります。

入力構成で エクスポート セクションを定義するリソース マニフェストを持つリソースのみを指定します。 各リソースの種類を 1 回だけ定義します。 構成ドキュメントに、リソースの種類がエクスポートできない、または構成で既に宣言されているリソース インスタンスが含まれている場合、DSC はエラーを発生させます。

オプション

-d、--document

JSON または YAML オブジェクトとしてエクスポートする構成ドキュメントを指定します。 DSC は、構成ドキュメント スキーマに対してドキュメントを検証します。 検証に失敗すると、DSC によってエラーが発生します。

このオプションは、stdin または --path オプションの構成ドキュメントでは使用できません。 構成ドキュメントを stdin 経由でコマンドに渡すか、 オプションを持つ --path ファイルから、または オプションを指定して渡すかを --document 選択します。

Type:      String
Mandatory: false

-p、--path

stdin からドキュメントをパイプ処理したり、 オプションを使用して文字列として渡したりする代わりに、エクスポートする構成ドキュメントへのパスを --document 定義します。 指定したファイルには、JSON または YAML オブジェクトとして構成ドキュメントが含まれている必要があります。 DSC は、構成ドキュメント スキーマに対してドキュメントを検証します。 検証が失敗した場合、または指定したファイルが存在しない場合は、DSC によってエラーが発生します。

このオプションは、 オプションと相互に --document 排他的です。 このオプションを使用すると、DSC は stdin からの入力を無視します。

Type:      String
Mandatory: false

-f、--format

オプションは --format 、コマンドのコンソール出力形式を制御します。 コマンド出力がリダイレクトされるか、変数としてキャプチャされる場合、出力は常に JSON になります。

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

-h, --help

現在のコマンドまたはサブコマンドのヘルプを表示します。 このオプションを指定すると、アプリケーションはこの後のすべてのオプションと引数を無視します。

Type:      Boolean
Mandatory: false

出力

このコマンドは、入力構成で宣言されたリソースのすべてのインスタンスを含む構成ドキュメントを定義する JSON 出力を返します。 詳細については、「 DSC 構成ドキュメント スキーマ リファレンス」を参照してください。