次の方法で共有

dsc config get

概要

設定ドキュメント内のリソースインスタンスの現在の状態を取得します。

構文

ファイルからの設定文書

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

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

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

stdinからの設定文書

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

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

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

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

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

説明

get サブコマンドは、構成文書内のリソース・インスタンスの実際の状態を戻します。 このコマンドを実行すると、DSC は、ドキュメントで定義されている各リソース インスタンスに対して get 操作を呼び出す前に、構成ドキュメントを検証します。

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

例示

例 1 - 構成のリソース インスタンスの現在の状態を取得する

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

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/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 --file -

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

このコマンドは、 --file オプションを使用して、 example.dsc.config.yaml ファイルで定義されているリソース インスタンスを取得します。

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

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

このコマンドでは、 --input オプションを使用して、 $desired 変数に格納された設定ドキュメントで定義されたリソース・インスタンスを取得します。

dsc config get --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 config get result スキーマ」を参照してください。

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

  • Last updated on