次の方法で共有

DSC設定のエクスポート

概要

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

構文

ファイルからの設定文書

dsc config export [Options] --file <FILE>

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

dsc config export [Options] --input <INPUT>

stdinからの設定文書

cat <FILE> | dsc config export [Options] --file -

stdinのパラメータを持つファイルからの設定文書

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>

stdinのパラメータを持つオプション文字列からの設定文書

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>

説明

export サブコマンドは、リソース・セットのすべてのインスタンスを含む構成文書を生成します。

設定ドキュメントは、 --input または --file オプションを指定して JSON または YAML としてこのコマンドに渡す必要があります。

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

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

例示

例 1 - 構成のリソース インスタンスが目的の状態にあるかどうかをテストする

このコマンドは、システムを検査して、 example.dsc.config.yamlとして保存された設定ドキュメントで定義されているリソースのすべての検出されたインスタンスを含む設定ドキュメントを返します。 --fileオプションを使用して、stdinから設定ドキュメントをコマンドに渡します。

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Operating system information
  type: Microsoft/OSInfo
  properties: {}
- name: Processes
  type: Microsoft/Process
  properties: {}

cat ./example.dsc.config.yaml | dsc config export --file -

例 2 - 設定ドキュメントとして読み取るファイルを渡す

このコマンドは、 --file オプションを使用して、 example.dsc.config.yaml ファイルで定義されている構成からリソースをエクスポートします。

dsc config export --file ./example.dsc.config.yaml

例 3 - 設定ドキュメントを変数として渡す

このコマンドは、 --input オプションを使用して、 $desired 変数に格納された構成からリソースを出力します。

dsc config export --input $desired

オプション

-i, --input

状態を検証する設定ドキュメントを指定します。

ドキュメントは、JSON または YAML オブジェクトを含む文字列である必要があります。 DSC は、構成ドキュメント スキーマに対してドキュメントを検証します。 検証が失敗した場合、DSC はエラーを発生させます。

このオプションは、 --file オプションと相互に排他的です。

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --file

状態を検証する設定ドキュメントへのパスを定義します。

指定するファイルには、設定ドキュメントを JSON または YAML オブジェクトとして含める必要があります。 DSC は、構成ドキュメント スキーマに対してドキュメントを検証します。 検証が失敗した場合、または指定したファイルが存在しない場合、DSC はエラーを発生させます。

このオプションを使用して、 例 1 に示すように、stdin から設定ドキュメントを渡すこともできます。

このオプションは、 --input オプションと相互に排他的です。

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-o, --output-format

--output-format オプションは、コマンドが返すデータに DSC が使用する形式を制御します。 使用可能な形式は次のとおりです。

  • json を使用して、データを JSON 行として出力します。
  • pretty-json を使用して、データを JSON として出力し、読みやすくするために改行、インデント、スペースを使用します。
  • yaml を使用して、データを YAML として出力します。

既定の出力形式は、出力がリダイレクトされているか、変数としてキャプチャされているかを DSC が検出するかどうかによって異なります。

  • コマンドがリダイレクトまたはキャプチャされていない場合、DSC はコンソールに出力を yaml 形式で表示します。
  • コマンド出力がリダイレクトまたはキャプチャされた場合、DSC はデータを json 形式で stdout に出力します。

このオプションを使用すると、DSC は、コマンドがリダイレクトされるかキャプチャされるかに関係なく、指定された形式を使用します。

コマンドがリダイレクトまたはキャプチャされない場合、コンソールの出力は読みやすさを向上させるためにフォーマットされます。 コマンドがリダイレクトまたはキャプチャされていない場合、出力には書式設定用のターミナル シーケンスが含まれます。

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h、--help

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

アウトプット

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

出力データのフォーマットの詳細については、 --output-format オプションを参照してください。

  • Last updated on