パラメーター

概要

構成パラメーターの値を返します。

構文

parameters('<name>')

説明

parameters() 関数は、特定のパラメータの値を返します。 有効なパラメータの名前を渡す必要があります。 この関数をリソース インスタンスに使用する場合、DSC は、この関数の実行後、現在の操作のリソースを呼び出す前に、インスタンスのプロパティを検証します。 参照されているパラメーター値がプロパティに対して無効な場合、DSC は検証エラーを発生させます。

設定ドキュメントでのパラメータの定義の詳細については、「 DSC 設定ドキュメントのパラメータ スキーマ」を参照してください。

例示

例 1 - パラメーターをリソース インスタンスのプロパティ値として使用する

この構成では、 parameters() 関数を使用して message パラメーターの値をエコーします。

# parameters.example.1.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
  message:
    type:         string
    defaultValue: Hello, world!
resources:
  - name: Echo message parameter
    type: Microsoft.DSC.Debug/Echo
    properties:
      output: "[parameters('message')]"

まず、 --parameters または --parameters_file オプションでパラメーターを上書きせずに、構成の現在の状態を取得します。 出力には、 message パラメーターのデフォルト値が表示されます。

config_file=parameters.example.1.dsc.config.yaml
cat $config_file | dsc config get

results:
- name: Echo message parameter
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hello, world!
messages: []
hadErrors: false

次に、 message パラメーターを --parameters オプションでオーバーライドします。

params='{"parameters": {"message": "Hi, override."}}'
cat $config_file | dsc config --parameters $params get

results:
- name: Echo message parameter
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hi, override.
messages: []
hadErrors: false

パラメーター

名前

parameters() 関数は、返されるパラメーターの名前を表す 1 つの文字列を入力として想定しています。 指定した名前のパラメーターが構成ドキュメントに定義されていない場合、DSC は検証中にエラーを発生させます。

Type:         string
Required:     true
MinimumCount: 1
MaximumCount: 1

アウトプット

parameters() 関数は、指定されたパラメータの値を返します。

Type: [string, int, bool, object, array]