dsc 配置

概要

应用配置文档。

语法

dsc config [Options] <COMMAND>

DESCRIPTION

该 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 配置函数在配置中引用资源实例的该文件夹路径。