dsc config get

Artigo
06/24/2024

Sinopse

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

Syntax

Documento de configuração do stdin

<document-string> | dsc config get [Options]

Documento de configuração da cadeia de caracteres de opção

dsc config get [Options] --document <document-string>

Documento de configuração do arquivo

dsc config get [Options] --path <document-filepath>

Descrição

O get subcomando retorna o estado atual 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 esse comando como JSON ou YAML sobre stdin, como uma cadeia de caracteres com a opção de documento ou de um arquivo com a opção path .

Exemplos

Exemplo 1 – Obter o estado atual das instâncias de recurso de uma configuração

O comando retorna o estado real para as instâncias de recurso definidas no documento de configuração salvo como example.dsc.config.yaml.

# example.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/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

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

O comando usa a opção path 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 opção de documento para recuperar as instâncias de recurso definidas em um documento de configuração armazenado na $desired variável .

dsc config get --document $desired

Opções

-d, --document

Especifica o documento de configuração para o qual recuperar o estado real. O documento deve ser uma cadeia de caracteres que contém um objeto JSON ou YAML. A DSC valida o documento em relação ao esquema do documento de configuração. Se a validação falhar, a DSC gerará um erro.

Essa opção não pode ser usada com o documento de configuração sobre stdin ou a opção --path . Escolha se deseja passar o documento de configuração para o comando sobre stdin, de um arquivo com a opção --path ou com a opção --document .

Type:      String
Mandatory: false

-p, --path

Define o caminho para um documento de configuração para recuperar o estado real para, em vez de canalizar o documento de stdin ou passá-lo como uma cadeia de caracteres com a opção --document . O arquivo especificado deve conter um documento de configuração como um objeto JSON ou YAML. A 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, a DSC gerará um erro.

Essa opção é mutuamente exclusiva com a opção --document . Quando você usa essa opção, a DSC ignora qualquer entrada de stdin.

Type:      String
Mandatory: false

-f, --format

A --format opção controla o formato de saída do console para o comando . Se a saída do comando for redirecionada ou capturada como uma variável, a saída será sempre JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-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

Saída

Esse comando retorna uma saída JSON que inclui se a operação ou quaisquer recursos geraram erros, a coleção 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.

Compartilhar via