次の方法で共有

dsc 構成セット

概要

構成ドキュメント内のリソース インスタンスの目的の状態を適用します。

構文

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

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

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

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

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

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

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

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

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

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

形容

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

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

例

例 1 - 構成のリソース インスタンスを目的の状態に設定する

このコマンドは、 example.dsc.config.yaml として保存された設定ドキュメントで定義されているリソースインスタンスを検査し、必要に応じてそれらを目的の状態に設定します。

# 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 set --file -

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

このコマンドは、 file オプションを使用して、 example.dsc.config.yaml ファイルで定義された設定を強制します。

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

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

このコマンドは、 入力 オプションを使用して、 $desired 変数に格納された構成を強制します。

dsc config set --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>

-w、--what-if

このフラグ オプションを指定すると、DSC は実際には set 操作でシステム状態を変更しません。 代わりに、このオプションなしで呼び出された場合に操作がシステム状態 をどのように変更するか を示す出力を返します。 DSC がシステムに加える変更をプレビューするには、このオプションを使用します。

このオプションを使用した場合のコマンドの出力は、ExecutionTypeメタデータフィールドが Actual ではなく WhatIf に設定されていることを除いて、なしと同じです。

Type        : boolean
Mandatory   : false
LongSyntax  : --what-if
ShortSyntax : -w

-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