通过

DSC 资源_purge属性架构

概要

指示资源应将列表中的未定义条目视为无效。

元数据

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/properties/purge.json
Type:          [boolean, 'null']
WriteOnly:     true

DESCRIPTION

DSC 需要区分列表中的非托管条目是有效的还是必须删除的 DSC 资源可以定义 _purge 该属性。

当资源的实例架构定义此属性时，它表示资源根据实例所需状态中的属性值更改其行为：

  • 当 is 时_purgetrue，资源将删除非托管条目。 该资源将实例所需状态中未列出的任何条目视为无效。
  • 当 is false 或 not 指定时_purge，资源将忽略非托管条目。

当资源定义此属性时，它应始终记录哪些属性或哪些属性 _purge 受到影响。 资源可以定义为 _purge 复杂属性的子属性。

此属性是仅写的。 使用该 _purge 属性的资源绝不应以实例的输出状态返回 _purge 。 资源不得定义为 _purge 必需属性。

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

"_purge": {
  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/purge.json"
}
  • Last updated on