dsc resource test result schema reference (Referência do esquema do resultado do teste de recursos do dsc)

Sinopse

O resultado do dsc resource test 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/test.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 testado de uma instância não aninhada ou uma matriz de objetos que descrevem o estado testado das instâncias aninhadas para um recurso de grupo ou adaptador.

O DSC devolve uma resposta de teste simples quando a instância não é um recurso de grupo, um recurso de adaptador ou aninhada 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 teste completo, que também inclui o tipo de recurso e o nome da instância.

Resposta de teste simples

Propriedades obrigatórias

O resultado inclui sempre estas propriedades:

• desiredState

Propriedades

desiredState

Representa o estado pretendido da instância de recurso. O DSC valida o valor desta propriedade em relação ao esquema de instância do recurso.

Type:     object
Required: true

actualState

Representa o estado real da instância de recurso. O DSC valida o valor desta propriedade em relação ao esquema de instância do recurso.

Type:     object
Required: true

inDesiredState

Indica se as propriedades da instância de recurso estão no estado pretendido. Este valor é true se cada propriedade estiver no estado pretendido e, caso contrário false, .

Type:     boolean
Required: true

differingProperties

Define os nomes das propriedades que não estão no estado pretendido. Se este valor for uma matriz vazia, as propriedades da instância estão no estado pretendido.

Type:      array
Required:  true
ItemsType: string

Resultado completo do teste

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

• Para cada instância num documento de configuração quando utiliza o dsc config test comando .
• Para instâncias aninhadas de um grupo ou recurso de adaptador quando utiliza o dsc resource test 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.

• 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 carateres, seguindo o formato definido no 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 de validação do recurso. Este valor é:

• A resposta de teste 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