概要
指示实例是否处于所需状态。
元数据
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/properties/inDesiredState.json
Type: [boolean, 'null']
ReadOnly: true
DESCRIPTION
canonical _inDesiredState 属性指示资源实例是否处于所需状态。 资源的实例架构是否应包含此属性取决于资源的 清单 是否定义了 test 属性。
如果资源的清单未定义 test,则资源依赖于 DSC 的综合测试。 资源的实例架构不得包含该 _inDesiredState 属性。
如果资源的清单定义了 test,则实例架构必须包含该 _inDesiredState 属性。 当资源返回 get 和 set作的实例状态时, _inDesiredState 必须为 null. 当资源返回测试作的实例状态时,_inDesiredState如果实例处于所需状态,则必须false为 true 。
此属性为只读。 资源返回具有此属性的实例,但 desired state 不能包含它。
要将此属性添加到资源的实例架构中,请使用以下代码段定义该属性:
"_inDesiredState": {
"$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json"
}