dsc config obter

Sinopse

Recupera o estado atual das instâncias de recursos em um documento de configuração.

Sintaxe

Documento de configuração do arquivo

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

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

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

Documento de configuração do stdin

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

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

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

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

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

Descrição

O get subcomando retorna o estado real das instâncias de recurso em um documento de configuração. Quando esse comando é executado, o DSC valida o documento de configuração antes de invocar a operação get para cada instância de recurso definida no documento.

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

Exemplos

Exemplo 1 - Obter o estado atual das instâncias de recursos de uma configuração

O comando retorna o estado real das instâncias de recurso definidas 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: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

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

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

O comando usa a --file opção para recuperar as instâncias de recurso definidas no example.dsc.config.yaml arquivo.

dsc config get --path ./example.dsc.config.yaml

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

O comando usa a --input opção para recuperar as instâncias de recurso definidas em um documento de configuração armazenado na $desired variável.

dsc config get --input $desired

Opções

-i, --entrada

Especifica o documento de configuração para o qual recuperar o estado real.

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 recuperar o estado real.

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 incluem se a operação ou quaisquer recursos geraram erros, a coleta de mensagens emitidas durante a operação e os resultados da operação get para cada instância. Para obter mais informações, consulte dsc config get result schema.

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