共用方式為


dsc 資源匯出

概要

生成定義特定資源的現有實例的配置文件。

語法

無實例屬性

dsc resource export [Options] --resource <RESOURCE>

input 選項中的實例屬性

dsc resource export --input <INPUT> --resource <RESOURCE>

檔中的實例屬性

dsc resource export --file <FILE> --resource <RESOURCE>

stdin 中的實例屬性

cat <FILE> | dsc resource get [Options] --resource <RESOURCE> --file -

說明

export 子命令生成一個包含特定資源的每個實例的配置文件。 必須使用 option 指定 --resource 資源。

從 DSC 3.1.0 開始,您可以使用 --input or --file 選項指定要用作匯出資源的篩選器的資源實例。 執行此作時,指定的實例將傳遞給資源以用於篩選。 篩選的實現取決於每個資源,而不是 DSC 本身。

僅使用定義輸入配置中的 export 部分的資源清單指定可匯出資源。 如果指定的資源類型不可匯出,DSC 將引發錯誤。

選項

-r, --resource

指定要匯出的 DSC 資源的完全限定類型名稱,如 Microsoft.Windows/Registry.

完全限定的類型名稱語法為: <owner>[.<group>][.<area>]/<name>,其中:

  • owner 資源的維護作者或組織。
  • grouparea 是為資源啟用命名空間的可選名稱元件。
  • 用於 name 標識資源管理的元件。
Type        : string
Mandatory   : true
LongSyntax  : --resource <RESOURCE>
ShortSyntax : -r <RESOURCE>

-i, --輸入

指定要用作匯出資源實例的篩選器的資源實例。

該實例必須是包含 JSON 或 YAML 物件的字串。 DSC 根據資源的實例架構驗證物件。 如果驗證失敗,DSC 將引發錯誤。

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

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --file

定義文件的路徑,該檔定義要用作匯出資源實例的過濾器的資源實例。

指定的檔案必須包含表示資源有效屬性的 JSON 或 YAML 物件。 DSC 根據資源的實例架構驗證物件。 如果驗證失敗,或者指定的檔不存在,DSC 將引發錯誤。

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

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

-o, --output-format

--output-format 選項控制 DSC 對命令傳回的數據使用的格式。 可用格式包括:

  • jsonJSON 行的形式發出數據。
  • pretty-json 將數據作為 JSON 發出,並帶有換行符、縮進和空格以提高可讀性。
  • yaml 以 YAML 格式發送資料。

預設輸出格式取決於 DSC 是否偵測到輸出正在重定向或作為變數擷取:

  • 如果命令未重定向或捕獲,DSC 會在控制台中將輸出顯示為 yaml 格式。
  • 如果命令輸出被重定向或捕獲,DSC 會將數據作為 json 格式發送到 stdout。

使用此選項時,DSC 將使用指定的格式,而不管命令是重定向還是捕獲。

當命令未重定向或捕獲時,控制台中的輸出將被格式化以提高可讀性。 當命令未重定向或捕獲時,輸出包括用於格式化的終端序列。

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h,--help

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

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

輸出

此命令返回定義配置文件的格式化數據,其中包括 input 配置中聲明的資源的每個實例。 有關詳細資訊,請參閱 DSC 配置文件架構參考

有關輸出數據格式的更多資訊,請參閱 --output-format 選項