摘要
生成一个配置文档,该文档定义一组资源的现有实例。
语法
来自 stdin 的配置文档
<document-string> | dsc config export [Options]
选项字符串中的配置文档
dsc config export [Options] --document <document-string>
文件中的配置文档
dsc config export [Options] --path <document-filepath>
说明
子 export
命令生成一个配置文档,其中包含一组资源的每个实例。
配置文档必须通过 stdin 以 JSON 或 YAML 的形式传递到此命令,作为包含 document 选项的字符串,或者从具有 path 选项的文件中传递。
输入配置定义要导出的资源。 DSC 忽略操作的输入配置中为资源指定的任何属性,但输入文档和资源实例的任何属性仍必须针对配置文档和资源实例架构进行验证。
仅使用资源清单指定资源,该清单定义输入配置中的 导出 节。 仅定义每个资源类型一次。 如果配置文档包含资源类型不可导出或已在配置中声明的任何资源实例,DSC 将引发错误。
选项
-d, --document
指定要作为 JSON 或 YAML 对象从中导出的配置文档。 DSC 根据配置文档架构验证文档。 如果验证失败,DSC 将引发错误。
此选项不能与 stdin 或 --path
选项上的配置文档一起使用。 选择是将配置文档通过 stdin 传递到命令,还是从具有 --path
选项 --document
的 文件中传递。
Type: String
Mandatory: false
-p、 --path
定义要导出的配置文档的路径,而不是通过管道从 stdin 传递文档,或使用 选项将其作为字符串 --document
传递。 指定的文件必须包含 JSON 或 YAML 对象的配置文档。 DSC 根据配置文档架构验证文档。 如果验证失败,或者指定的文件不存在,DSC 将引发错误。
此选项与 --document
选项互斥。 使用此选项时,DSC 会忽略来自 stdin 的任何输入。
Type: String
Mandatory: false
-f, --format
选项 --format
控制命令的控制台输出格式。 如果将命令输出重定向或捕获为变量,则输出始终为 JSON。
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h、--help
显示当前命令或子命令的帮助。 指定此选项时,应用程序将忽略此选项之后的所有选项和参数。
Type: Boolean
Mandatory: false
输出
此命令返回 JSON 输出,该输出定义配置文档,包括输入配置中声明的每个资源实例。 有关详细信息,请参阅 DSC 配置文档架构参考。