摘要
生成一个配置文档,该文档定义资源的现有实例。
语法
dsc resource export [Options] --resource <RESOURCE>
说明
子 export
命令生成一个配置文档,其中包含特定资源的每个实例。 必须使用 选项指定 --resource
资源。
仅使用资源清单指定可导出的资源,该清单定义输入配置中的 导出 节。 如果指定的资源类型不可导出,DSC 将引发错误。
选项
-r、 --resource
指定要导出的 DSC 资源的完全限定类型名称,例如 Microsoft.Windows/Registry
。
完全限定的类型名称语法为: <owner>[.<group>][.<area>]/<name>
,其中:
- 是
owner
资源的维护作者或组织。 -
group
和area
是可选名称组件,用于为资源启用命名空间。 - 标识
name
资源管理的组件。
Type: String
Mandatory: true
-f, --format
选项 --format
控制命令的控制台输出格式。 如果将命令输出重定向或捕获为变量,则输出始终为 JSON。
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h、--help
显示当前命令或子命令的帮助。 指定此选项时,应用程序将忽略此选项之后的所有选项和参数。
Type: Boolean
Mandatory: false
输出
此命令返回 JSON 输出,该输出定义配置文档,包括输入配置中声明的每个资源实例。 有关详细信息,请参阅 DSC 配置文档架构参考。