DSC 配置

概要

應用配置文件。

語法

dsc config [Options] <COMMAND>

說明

該 dsc config 命令包括用於管理 DSC 配置文件中定義的資源實例的子命令。 要直接管理資源，請參閱 dsc resource 命令。

指令

匯出

該 export 命令會生成一個配置文檔，用於定義一組資源的現有實例。 有關更多資訊，請參閱 dsc config 導出。

get

該 get 命令檢索配置文件中資源實例的當前狀態。 有關更多資訊，請參閱 dsc config get。

設定

該 set 命令在配置文件中強制執行資源實例的所需狀態。 有關更多資訊，請參閱 dsc config set。

測試

該 test 命令驗證配置文件中的資源實例是否處於所需狀態。 有關更多資訊，請參閱 dsc config test。

幫助

該 help 命令返回此命令或子命令的幫助資訊。

要獲取命令或子命令的説明，請使用以下語法：

dsc config help [<SUBCOMMAND>]

例如， dsc config help 獲取此命令的説明。 dsc config help set 獲取子命令的 set 説明。

您還可以在命令或子命令上使用 --help 選項來顯示幫助資訊。 例如，dsc config --help 或 dsc config set --help。

選項

-f， --parameters-檔

指定包含要作為 JSON 或 YAML 傳遞給設定的參數的數據檔的路徑。 當您指定此選項時，DSC 會將數據檔中的 Key 解釋為參數，並使用指定的值。 數據檔中的值將覆蓋配置本身中定義的任何預設值。

數據文件必須包含具有 key 的物件 parameters 。 鍵的值 parameters 必須是一個物件，其中每個鍵都是已定義參數的名稱，每個值都是該參數的有效值。

此選項與 --parameters 選項互斥。

從 DSC 版本 3.1.0 開始，您可以通過 stdin 將 parameters 數據傳遞給子命令。 執行此作時，必須將配置文檔作為輸入字串或系統上檔的路徑傳遞。 您不能將 parameters 檔和設定文件都傳遞給 stdin 中的命令。

有關在配置文件中定義參數的更多資訊，請參閱 DSC 設定文件的參數架構。 有關在配置文件中使用參數的更多資訊，請參見 parameters函數參考。

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p， --parameters

指定要作為格式為 JSON 或 YAML 的數據字串傳遞給設定文件的參數。 當您指定此選項時，DSC 會將數據字串中的key解釋為參數，並使用指定的值。 data string 中的值將覆蓋 configuration document 本身中定義的任何預設值。

數據字串必須包含具有key的物件 parameters 。 鍵的值 parameters 必須是一個物件，其中每個鍵都是已定義參數的名稱，每個值都是該參數的有效值。

此選項與 --parameters_file 選項互斥。

有關在配置文件中定義參數的更多資訊，請參閱 DSC 設定文件的參數架構。 有關在配置文件中使用參數的更多資訊，請參見 parameters函數參考。

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r， --system-root

使用此選項可在您不以當前運行的作系統為目標時指定作系統根目錄的路徑。

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-h，--help

顯示當前命令或子命令的説明。 指定此選項時，應用程式將忽略所有其他選項和參數。

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

環境變數

dsc config *當您調用帶有選項的命令時，子命令會創建DSC_CONFIG_ROOT環境變數，以--path指定要用於該命令的配置文件。 DSC 將環境變數的值 DSC_CONFIG_ROOT 設置為包含指定配置文檔的資料夾的完整路徑。

您可以使用 envvar 設定函數在設定中引用資源實例的該資料夾路徑。