Partilhar via

Esquema de propriedade _exist de Recursos do DSC

  • Artigo

Sinopse

Indica se uma instância deve existir.

Metadados

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json
Type:          boolean
DefaultValue:  true

Description

A _exist propriedade indica que o recurso pode impor se existem instâncias, processar se uma instância deve ser adicionada, atualizada ou removida durante uma operação definida. Esta propriedade fornece semântica partilhada para recursos DSC e ferramentas de integração, mas não permite qualquer processamento incorporado adicional com o DSC.

Os recursos só devem definir esta propriedade quando a implementação cumprir o seguinte contrato de comportamento:

  1. Quando o estado pretendido para _exist for true, o recurso espera que a instância exista. Se não existir, o recurso cria ou adiciona a instância durante a operação definida.

  2. Quando o estado pretendido para _exist for false, o recurso espera que a instância não exista. Se existir, o recurso elimina ou remove a instância durante a operação definida.

  3. Quando a operação get consulta para uma instância que não existe, o JSON devolvido define sempre a _exist propriedade como false.

    O recurso pode omitir a _exist propriedade do JSON do resultado quando a instância existe.

Para adicionar esta propriedade ao esquema de instância de um recurso, defina a propriedade com o seguinte fragmento:

"_exist": {
  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json"
}