共用方式為

envvar

概要

返回環境變數的值。

語法

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

參數

variableName 變數名稱

該 envvar() 函數需要一個字串，該字串表示要使用的環境變數的名稱。 如果值不是字串，則 DSC 在驗證配置文檔時會引發錯誤。 如果輸入命名的環境變數不存在，DSC 會引發錯誤。

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

輸出

該 envvar() 函數返回使用 variableName 參數指定的環境變數的值。

Type: string
  • Last updated on