DSC 资源_exist属性架构

摘要

指示实例是否应存在。

元数据

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

描述

属性 _exist 指示资源可以强制实施实例是否存在，并处理在设置操作期间是应添加、更新还是删除实例。 此属性为 DSC 资源和集成工具提供共享语义，但不支持使用 DSC 进行任何其他内置处理。

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

1. 当 的所需状态 _exist 为 true时，资源预期实例存在。 如果不存在，资源会在设置操作期间创建或添加实例。

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

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

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

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

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