Compartilhar via

dsc resource get

  • Artigo

Sinopse

Invoca a operação get de um recurso.

Syntax

Sem propriedades de instância

dsc resource get [Options] --resource <RESOURCE>

Propriedades da instância de stdin

<instance-properties> | dsc resource get [Options] --resource <RESOURCE>

Propriedades da instância da opção de entrada

dsc resource get --input '<instance-properties>' --resource <RESOURCE>

Propriedades da instância do arquivo

dsc resource get --path <instance-properties-filepath> --resource <RESOURCE>

Descrição

O get subcomando retorna o estado atual de uma instância de recurso.

Por padrão, esse subcomando retorna uma instância de um recurso DSC específico. Para retornar vários recursos, use o --all parâmetro , um grupo de recursos ou o comando dsc config get .

Todas as propriedades que o recurso requer para recuperar o estado de uma instância devem ser passadas para esse comando como um objeto JSON ou YAML. O objeto pode ser passado para esse comando de stdin ou com a opção --input . Você também pode usar a opção --path para ler o objeto de um arquivo JSON ou YAML.

Exemplos

Exemplo 1 – Obter instância de recurso sem nenhuma entrada

Para recursos de instância única que não exigem nenhum valor de propriedade para retornar o estado real da instância de recurso, as propriedades da instância não são necessárias.

dsc resource get --resource Microsoft/OSInfo

actualState:
  $id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
  family: Windows
  version: 10.0.22621
  edition: Windows 11 Enterprise
  bitness: '64'

Exemplo 2 – Obter instância de recurso com a opção de entrada

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser passadas com a opção de entrada como JSON ou YAML.

dsc resource get --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}'

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Exemplo 3 – Obter instância de recurso com entrada de stdin

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser passadas por stdin como JSON ou YAML.

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Exemplo 4 – Obter instância de recurso com entrada de um arquivo YAML

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser recuperadas de um arquivo JSON ou YAML salvo.

cat ./example.yaml

keyPath:   HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot

dsc resource get --resource Microsoft.Windows/Registry --path ./example.yaml

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Opções

-a, --all

Especifica que o comando deve retornar todas as instâncias do Recurso DSC especificado em vez de uma instância específica.

Essa opção só é válida quando o Recurso é um recurso exportável que define a seção de exportação na configuração de entrada. Se o tipo de recurso não for exportável, a DSC gerará um erro.

Quando essa opção é especificada, o DSC ignora as --input opções e --path e qualquer JSON ou YAML enviado ao comando do stdin.

Type:      Boolean
Mandatory: false

-r, --resource

Especifica o nome de tipo totalmente qualificado do Recurso DSC a ser usado, como Microsoft.Windows/Registry.

A sintaxe de nome de tipo totalmente qualificado é: <owner>[.<group>][.<area>]/<name>, em que:

  • O owner é o autor ou organização que mantém o recurso.
  • Os group e area são componentes de nome opcionais que habilitam o espaçamento de nomes para um recurso.
  • O name identifica o componente que o recurso gerencia.
Type:      String
Mandatory: true

-i, --input

Especifica um objeto JSON ou YAML com as propriedades necessárias para recuperar uma instância do recurso DSC. A DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar, a DSC gerará um erro.

Essa opção não pode ser usada com propriedades de instância sobre stdin ou a opção --path . Escolha se deseja passar as propriedades da instância para o comando sobre stdin, de um arquivo com a opção --path ou com a opção --input .

A DSC ignora essa opção quando a opção --all é especificada.

Type:      String
Mandatory: false

-p, --path

Define o caminho para um arquivo de texto a ser lido como entrada para o comando em vez de canalizar a entrada de stdin ou passá-la como uma cadeia de caracteres com a opção --input . O arquivo especificado deve conter JSON ou YAML que represente propriedades válidas para o recurso. A DSC valida o objeto em relação ao esquema de instância do recurso. 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 --input . Quando você usa essa opção, a DSC ignora qualquer entrada de stdin.

A DSC ignora essa opção quando a opção --all é especificada.

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

Por padrão, esse comando retorna a saída JSON que inclui o estado real da instância. Quando a opção --all é especificada, o comando retorna a saída JSON para cada instância como Linhas JSON.

Para obter mais informações sobre a estrutura do JSON de saída, consulte dsc resource get result schema.