configuração de dsc

Sinopse

Aplicar um documento de configuração.

Sintaxe

dsc config [Options] <COMMAND>

Descrição

O dsc config comando inclui subcomandos para gerenciar as instâncias de recurso definidas em um documento de configuração de DSC. Para gerenciar recursos diretamente, consulte o comando dsc resource .

Comandos

exportar

O export comando gera um documento de configuração que define as instâncias existentes de um conjunto de recursos. Para obter mais informações, consulte exportação de configuração dsc.

get

O get comando recupera o estado atual das instâncias de recurso em um documento de configuração. Para obter mais informações, consulte dsc config get.

set

O set comando impõe o estado desejado das instâncias de recurso em um documento de configuração. Para obter mais informações, consulte dsc config set.

test

O test comando verifica se as instâncias de recurso em um documento de configuração estão no estado desejado. Para obter mais informações, consulte dsc config test.

ajuda

O help comando retorna informações de ajuda para esse comando ou um subcomando.

Para obter a ajuda de um comando ou subcomando, use a sintaxe :

dsc config help [<SUBCOMMAND>]

Por exemplo, dsc config help obtém a ajuda para este comando. dsc config help set obtém a ajuda para o set subcomando.

Você também pode usar a opção --help no comando ou subcomando para exibir as informações de ajuda. Por exemplo, dsc config --help ou dsc config set --help.

Opções

-f, --parameters_file

Especifica o caminho para um arquivo de dados que contém os parâmetros a serem passados para a configuração como JSON ou YAML. Quando você especifica essa opção, a DSC interpreta as chaves no arquivo de dados como parâmetros e usa os valores especificados. Os valores no arquivo de dados substituem os padrões definidos na própria configuração.

O arquivo de dados deve conter um objeto com a parameters chave . O valor da parameters chave deve ser um objeto em que cada chave é o nome de um parâmetro definido e cada valor é um valor válido para esse parâmetro.

Essa opção não pode ser usada com a opção --parameters . Escolha se deseja passar os parâmetros como uma cadeia de caracteres de dados com a opção --parameters ou em um arquivo de dados com a opção --parameters_file .

Para obter mais informações sobre como definir parâmetros em um documento de configuração, consulte Esquema de parâmetro de documento de configuração de DSC. Para obter mais informações sobre como usar parâmetros no documento de configuração, consulte a referência de função de parâmetros.

-p, --parameters

Especifica os parâmetros a serem passados para a configuração como uma cadeia de caracteres JSON ou YAML. Quando você especifica essa opção, o DSC interpreta as chaves na cadeia de caracteres de dados como parâmetros e usa os valores especificados. Os valores na cadeia de caracteres de dados substituem os padrões definidos na própria configuração.

A cadeia de caracteres de dados deve conter um objeto com a parameters chave . O valor da parameters chave deve ser um objeto em que cada chave é o nome de um parâmetro definido e cada valor é um valor válido para esse parâmetro.

Essa opção não pode ser usada com a opção --parameters_file . Escolha se deseja passar os parâmetros como uma cadeia de caracteres de dados com a opção --parameters ou em um arquivo de dados com a opção --parameters_file .

Para obter mais informações sobre como definir parâmetros em um documento de configuração, consulte Esquema de parâmetro de documento de configuração de DSC. Para obter mais informações sobre como usar parâmetros no documento de configuração, consulte a referência de função de parâmetros.

-h, --help

Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as opções e argumentos após essa.

Type:      Boolean
Mandatory: false

Variáveis de ambiente

Os dsc config * subcomandos criam a DSC_CONFIG_ROOT variável de ambiente quando você chama um comando com a opção --path de especificar o documento de configuração a ser usado para o comando. A DSC define o valor da variável de DSC_CONFIG_ROOT ambiente como o caminho completo da pasta que contém o documento de configuração especificado.

Observação

Se você definir a DSC_CONFIG_ROOT variável fora da DSC, a DSC gerará um aviso quando substituir o valor da variável de ambiente existente para uma operação.

Você pode usar a função de configuração envvar para referenciar esse caminho de pasta para instâncias de recurso na configuração.