obter recurso dsc

Artigo
03/06/2024

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 do 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 ficheiro

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

Description

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

Por predefinição, este subcomando devolve uma instância de um Recurso DSC específico. Para devolver vários recursos, utilize o --all parâmetro, um grupo de recursos ou o comando dsc config get .

Todas as propriedades necessárias para obter o estado de uma instância têm de ser transmitidas para este comando como um objeto JSON ou YAML. O objeto pode ser transmitido para este comando a partir de stdin ou com a opção --input . Também pode utilizar a opção --path para ler o objeto a partir de um ficheiro JSON ou YAML.

Exemplos

Exemplo 1 - Obter instância de recurso sem qualquer entrada

Para recursos de instância única que não necessitam de quaisquer valores de propriedade para devolver 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 a instância de recurso com a opção de entrada

Se um recurso precisar de um ou mais valores de propriedade para devolver o estado real da instância, as propriedades da instância podem ser transmitidas 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 a instância de recursos com a entrada de stdin

Se um recurso precisar de um ou mais valores de propriedade para devolver o estado real da instância, as propriedades da instância podem ser transmitidas 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 a instância de recurso com a entrada de um ficheiro YAML

Se um recurso precisar de um ou mais valores de propriedade para devolver o estado real da instância, as propriedades da instância podem ser obtidas a partir de um ficheiro JSON ou YAML guardado.

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 devolver todas as instâncias do Recurso DSC especificado em vez de uma instância específica.

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

Quando esta opção é especificada, o DSC ignora as --input opções e --path e quaisquer JSON ou YAML enviados para o comando a partir de stdin.

Type:      Boolean
Mandatory: false

-r, --resource

Especifica o nome de tipo completamente qualificado do Recurso do DSC a utilizar, como Microsoft.Windows/Registry.

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

É owner o autor ou organização responsável pela manutenção do recurso.
Os group e area são componentes de nomes opcionais que permitem o espaçamento de nomes para um recurso.
O name identifica o componente que o recurso gere.

Type:      String
Mandatory: true

-i, --input

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

Esta opção não pode ser utilizada com as propriedades da instância através de stdin ou da opção --path . Escolha se pretende transmitir as propriedades da instância para o comando por stdin, a partir de um ficheiro com a opção --path ou com a opção --input .

O DSC ignora esta opção quando a opção --all é especificada.

Type:      String
Mandatory: false

-p, --path

Define o caminho para um ficheiro de texto para ler como entrada para o comando em vez de encaminhar a entrada de stdin ou transmiti-lo como uma cadeia com a opção --input . O ficheiro especificado tem de conter JSON ou YAML que represente propriedades válidas para o recurso. O DSC valida o objeto em relação ao esquema de instância do recurso. 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 --input . Quando utiliza esta opção, o DSC ignora qualquer entrada de stdin.

O DSC ignora esta opção quando a opção --all é especificada.

Type:      String
Mandatory: false

-f, --format

A --format opção controla o formato de saída da consola 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

Apresenta a ajuda do 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

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

Para obter mais informações sobre a estrutura do JSON de saída, veja dsc resource get result schema (Esquema de resultados de obtenção de recursos dsc).

Partilhar via