変数

概要

構成変数の値を返します。

構文

variables('<name>')

説明

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

設定ドキュメントでの変数の定義の詳細については、「 DSC 設定ドキュメントのスキーマ リファレンス」を参照してください。

例示

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

あらすじの例

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

dsc config get --file variables.example.1.dsc.config.yaml

results:
- metadata:
    Microsoft.DSC:
      duration: PT0.0883345S
  name: Echo message variable
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: Hello, world!

パラメーター

名前

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

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

アウトプット

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

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