エンバイバー

概要

環境変数の値を返します。

構文

envvar(<variableName>)

説明

envvar() 関数は、環境変数の値を文字列として返します。 環境変数が存在しない場合、DSC はエラーを発生させます。

例示

例 1 - コンフィギュレーション内の参照DSC_CONFIG_ROOT

--path オプションを使用して dsc config * コマンドの設定ドキュメントを指定すると、DSC は自動的に DSC_CONFIG_ROOT 環境変数を作成し、指定した設定ドキュメントの親フォルダに値を設定します。 詳細については、 dsc config コマンドリファレンスを参照してください。

この構成は、そのフォルダーを Microsoft.DSC.Debug/Echo リソースとエコーします。

# ./examples/envvar.example.1.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Echo 'DSC_CONFIG_ROOT' in envvar
    type: Microsoft.DSC.Debug/Echo
    properties:
      output: "[envvar('DSC_CONFIG_ROOT')]"

dsc config get --path ~/dsc/examples/envvar.example.1.dsc.config.yaml

results:
- name: Echo DSC_CONFIG_ROOT
  type: Microsoft.DSC.Debug/Echo
  result:
    actualState:
      output: ~/dsc/examples
messages: []
hadErrors: false

パラメーター

変数名

envvar() 関数は、使用する環境変数の名前を表す 1 つの文字列を想定しています。 値が文字列でない場合、DSC は構成ドキュメントの検証時にエラーを発生させます。 入力によって名前が付けられた環境変数が存在しない場合、DSC はエラーを発生させます。

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

アウトプット

envvar() 関数は、variableName パラメータで指定された環境変数の値を返します。

Type: string