概要
生成定义特定资源的现有实例的配置文档。
语法
无实例属性
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 -
DESCRIPTION
该 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 对命令返回的数据使用的格式。 可用格式包括：
-
json以 JSON 行的形式发出数据。 -
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 选项。
