Compartilhar via

Referência de esquema de resultado do conjunto de recursos dsc

  • Artigo

Sinopse

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

Metadados

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

Descrição

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

O DSC retorna uma resposta de conjunto 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 de adaptador ou aninhado dentro de um grupo ou recurso de adaptador, o DSC retorna um resultado de conjunto completo, que também inclui o tipo de recurso e o nome da instância.

Resposta de conjunto simples

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

Propriedades obrigatórias

A saída sempre inclui estas propriedades:

Propriedades

beforeState

Representa o estado da instância retornada antes da operação definida. O DSC valida o valor dessa propriedade em relação ao esquema de instância do recurso.

Type:     object
Required: true

afterState

Representa o estado da instância retornada após a operação definida. O DSC valida o valor dessa propriedade em relação ao esquema de instância do recurso.

Type:     object
Required: true

changedProperties

Define os nomes das propriedades impostas pela operação de conjunto. Se esse valor for uma matriz vazia, o recurso não fez alterações durante a operação definida.

Type:      array
Required:  true
ItemsType: string

Resultado completo do conjunto

Descreve os dados de retorno para o resultado completo da set 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 set comando .
  • Para instâncias aninhadas de um grupo ou recurso de adaptador quando você usa o dsc resource set 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 imposto para o recurso. Esse valor é:

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