通过

DSC 资源_exist属性架构

概要

指示是否应存在实例。

元数据

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

DESCRIPTION

canonical _exist 属性指示资源可以强制执行实例是否存在，处理在 set作期间是否应添加、更新或删除实例。 此属性为 DSC 资源和集成工具提供共享语义。 定义此属性的资源向 DSC 指示它们遵守 canonical 属性的协定。

仅当资源的实现符合以下行为协定时，资源才应定义此属性：

  1. 当 的 _exist 所需状态为 时 true，资源期望实例存在。 如果不存在，则资源将在 set作期间创建或添加实例。

  2. 当 的 _exist 所需状态为 false时，资源预期实例不存在。 如果存在，则资源将在 set作期间删除或移除实例。

  3. 当 get作查询不存在的实例时，返回的 JSON 始终将 _exist 属性 false定义为 .

    当实例存在时，资源 可能会 从结果 JSON 中省略 _exist 该属性。

要将此属性添加到资源的实例架构中，请使用以下代码段定义该属性：

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