Exportação de configuração DSC

Sinopse

Gera um documento de configuração que define as instâncias existentes de um conjunto de recursos.

Sintaxe

Documento de configuração do arquivo

dsc config export [Options] --file <FILE>

Documento de configuração a partir da cadeia de opções

dsc config export [Options] --input <INPUT>

Documento de configuração do stdin

cat <FILE> | dsc config export [Options] --file -

Documento de configuração do arquivo com parâmetros do stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>

Documento de configuração da string de opção com parâmetros do stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>

Descrição

O export subcomando gera um documento de configuração que inclui todas as instâncias de um conjunto de recursos.

O documento de configuração deve ser passado para este comando como JSON ou YAML com a --input opção or --file .

O documento de entrada define os recursos a serem exportados. O DSC ignora todas as propriedades especificadas para os recursos na configuração de entrada para a operação, mas o documento de entrada e quaisquer propriedades para instâncias de recursos ainda devem ser validadas em relação ao documento de configuração e esquemas de instância de recurso.

Especifique apenas recursos com um manifesto de recurso que defina a seção de exportação na configuração de entrada. Defina cada tipo de recurso apenas uma vez. Se o documento de configuração incluir qualquer instância de recurso em que o tipo de recurso não seja exportável ou já tenha sido declarado na configuração, o DSC gerará um erro.

Exemplos

Exemplo 1 - Teste se as instâncias de recursos de uma configuração estão no estado desejado

O comando inspeciona o sistema para retornar um documento de configuração contendo cada instância descoberta dos recursos definidos no documento de configuração salvo como example.dsc.config.yaml. Ele passa o documento de configuração para o comando do stdin usando a --file opção.

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Operating system information
  type: Microsoft/OSInfo
  properties: {}
- name: Processes
  type: Microsoft/Process
  properties: {}

cat ./example.dsc.config.yaml | dsc config export --file -

Exemplo 2 - Passando um arquivo para ler como o documento de configuração

O comando usa a --file opção para exportar recursos da configuração definida no example.dsc.config.yaml arquivo.

dsc config export --file ./example.dsc.config.yaml

Exemplo 3 - Passando um documento de configuração como uma variável

O comando usa a --input opção para exoirt recursos da configuração armazenada na $desired variável.

dsc config export --input $desired

Opções

-i, --entrada

Especifica o documento de configuração para o qual validar o estado.

O documento deve ser uma cadeia de caracteres contendo um objeto JSON ou YAML. O DSC valida o documento em relação ao esquema do documento de configuração. Se a validação falhar, o DSC gerará um erro.

Esta opção exclui-se mutuamente com a --file opção.

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --ficheiro

Define o caminho para um documento de configuração para o qual validar o estado.

O arquivo especificado deve conter um documento de configuração como um objeto JSON ou YAML. O DSC valida o documento em relação ao esquema do documento de configuração. Se a validação falhar ou se o arquivo especificado não existir, o DSC gerará um erro.

Você também pode usar essa opção para passar um documento de configuração do stdin, conforme mostrado no Exemplo 1.

Esta opção exclui-se mutuamente com a --input opção.

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-o, --formato de saída

A --output-format opção controla qual formato o DSC usa para os dados retornados pelo comando. Os formatos disponíveis são:

• json para emitir os dados como uma linha JSON.
• pretty-json para emitir os dados como JSON com novas linhas, recuo e espaços para legibilidade.
• yaml para emitir os dados como YAML.

O formato de saída padrão depende se o DSC deteta que a saída está sendo redirecionada ou capturada como uma variável:

• Se o comando não estiver sendo redirecionado ou capturado, o DSC exibirá a saída como o yaml formato no console.
• Se a saída do comando for redirecionada ou capturada, o DSC emitirá os dados como o json formato para stdout.

Quando você usa essa opção, o DSC usa o formato especificado, independentemente de o comando estar sendo redirecionado ou capturado.

Quando o comando não é redirecionado ou capturado, a saída no console é formatada para melhorar a legibilidade. Quando o comando não é redirecionado ou capturado, a saída inclui sequências de terminal para formatação.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --ajuda

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Resultado

Este comando retorna dados formatados que definem um documento de configuração, incluindo cada instância dos recursos declarados na configuração de entrada. Para obter mais informações, consulte Referência de esquema de documento de configuração DSC.

Para obter mais informações sobre a formatação dos dados de saída, consulte a opção --output-format.