dsc resource get result schema reference (Referência do esquema de resultados do recurso dsc)

Sinopse

O 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/v3.1.0/outputs/resource/get.json
Type:          object

Description

Descreve os dados devolvidos de uma instância de Recurso do DSC a dsc resource get partir do comando . Os dados devolvidos 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 devolve uma resposta de obtenção simples quando a instância não é um recurso de grupo, um recurso de adaptador ou aninhado dentro de um recurso de grupo ou adaptador.

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

Obter resposta simples

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

Propriedades obrigatórias

O resultado inclui sempre estas propriedades:

• actualState

Propriedades

actualState

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

Type:     object
Required: true

Resultado de obtenção completo

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

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

Propriedades obrigatórias

• metadados
• nome
• tipo
• resultado

Propriedades

do IdP

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

• a duração 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 carateres, 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 pelo respetivo nome de tipo completamente qualificado. Para obter mais informações sobre nomes de tipos, veja Referência de esquema de nome de tipo completamente qualificado do Recurso DSC.

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

name

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

Type:     string
Required: true

result

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

• A resposta get simples para a instância
• Uma matriz de objetos de resultado get completos para cada instância aninhada, se o recurso for um recurso de grupo ou adaptador.

Type: [object, array]
Required: true