obter configuração dsc

Artigo
06/24/2024

Sinopse

Obtém o estado atual das instâncias de recursos num documento de configuração.

Syntax

Documento de configuração do stdin

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

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

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

Documento de configuração do ficheiro

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

Description

O get subcomando devolve o estado atual das instâncias de recursos num documento de configuração. Quando este 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 tem de ser transmitido para este comando como JSON ou YAML através de stdin, como uma cadeia com a opção de documento ou a partir de um ficheiro com a opção caminho .

Exemplos

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

O comando devolve o estado real das instâncias de recursos definidas no documento de configuração guardado 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 - Transmitir um ficheiro para ler como o documento de configuração

O comando utiliza a opção caminho para obter as instâncias de recursos definidas no example.dsc.config.yaml ficheiro.

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

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

O comando utiliza a opção de documento para obter as instâncias de recursos definidas num 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 que obter o estado real. O documento tem de ser uma cadeia que contenha um objeto JSON ou YAML. O DSC valida o documento relativamente ao esquema do documento de configuração. Se a validação falhar, o DSC gera um erro.

Esta opção não pode ser utilizada com o documento de configuração através de stdin ou da opção --path . Escolha se pretende transmitir o documento de configuração para o comando por stdin, a partir de um ficheiro 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 obter o estado real para, em vez de encaminhar o documento de stdin ou transmiti-lo como uma cadeia com a opção --document . O ficheiro especificado tem de conter um documento de configuração como um objeto JSON ou YAML. O DSC valida o documento relativamente ao esquema do documento de configuração. Se a validação falhar ou se o ficheiro especificado não existir, o DSC gera um erro.

Esta opção é mutuamente exclusiva com a opção --document . Quando utiliza esta opção, o DSC ignora qualquer entrada de stdin.

Type:      String
Mandatory: false

-f, --format

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

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

-h, --help

Apresenta a ajuda para o comando ou subcomando atual. Quando especifica esta opção, a aplicação ignora todas as opções e argumentos após esta.

Type:      Boolean
Mandatory: false

Saída

Este comando devolve 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 obter para cada instância. Para obter mais informações, veja dsc config get result schema (Obter esquema de resultados).

Partilhar via