Compartilhar via

dsc resource get result schema reference

  • Artigo

Sinopse

A saída do resultado do dsc resource get comando.

Metadados

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/get.json
Type:          object

Descrição

Descreve os dados de retorno de uma instância de recurso DSC do dsc resource get comando . Os dados retornados são um único objeto que descreve o estado real de uma instância não aninhada ou uma matriz de objetos que descrevem o estado real das instâncias aninhadas para um recurso de grupo ou adaptador.

O DSC retorna uma resposta get simples quando a instância não é um recurso de grupo, um recurso de adaptador ou aninhado dentro de um grupo ou recurso de adaptador.

Quando a instância recuperada é para recurso de grupo, recurso do adaptador ou aninhado dentro de um grupo ou recurso de adaptador, o DSC retorna um resultado de obtenção completo, que também inclui o tipo de recurso e o nome da instância.

Resposta de obtenção simples

Descreve os dados de retorno de uma única instância de recurso DSC do dsc resource get comando . Esses dados são retornados para instâncias que não são recursos de grupo, recursos do adaptador ou aninhados dentro de um grupo ou recurso de adaptador.

Propriedades obrigatórias

A saída sempre inclui estas propriedades:

Propriedades

actualState

A actualState propriedade sempre inclui o estado da instância retornada quando o DSC invoca a operação get do recurso. O DSC valida o valor dessa propriedade em relação ao esquema de instância do recurso.

Type:     object
Required: true

Resultado completo da obtenção

Descreve os dados de retorno para o resultado completo da get operação para uma instância de recurso. Esses dados são retornados:

  • Para cada instância em um documento de configuração quando você usa o dsc config get comando .
  • Para instâncias aninhadas de um grupo ou recurso de adaptador quando você usa o dsc resource get comando .

Propriedades obrigatórias

Propriedades

metadata

Define os retornos de DSC de metadados para uma operação de configuração. As propriedades na Microsoft.DSC propriedade descrevem o contexto da operação.

  • duration define a duração de uma operação DSC em relação a um documento de configuração ou instância de recurso como uma cadeia de caracteres seguindo o formato definido em ISO8601 ABNF para duration. Por exemplo, PT0.611216S representa uma duração de cerca 0.61 de segundos.
Type:     object
Required: true

tipo

A type propriedade identifica o Recurso DSC da instância por seu nome de tipo totalmente qualificado. Para obter mais informações sobre nomes de tipo, consulte Referência de esquema de nome de tipo totalmente qualificado do recurso DSC.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

name

A name propriedade identifica a instância por seu nome curto, exclusivo e legível por humanos.

Type:     string
Required: true

result

A result propriedade inclui o estado real do recurso. Esse valor é:

  • A resposta get simples para a instância
  • Uma matriz de objetos de resultado de obtenção completa para cada instância aninhada, se o recurso for um recurso de grupo ou adaptador.
Type: [object, array]
Required: true