通过

dsc 资源测试结果架构参考

摘要

命令的结果输出 dsc resource test 。

元数据

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/test.json
Type:          object

描述

描述命令中的 DSC 资源实例的 dsc resource get 返回数据。 返回数据可以是描述非嵌套实例的已测试状态的单个对象，或者是描述组或适配器资源的嵌套实例测试状态的对象数组。

当实例不是组资源、适配器资源或嵌套在组或适配器资源内时，DSC 将返回 简单的测试响应 。

当检索到的实例用于组资源、适配器资源或嵌套在组或适配器资源内时，DSC 将返回 完整的测试结果，其中还包括资源类型和实例名称。

简单测试响应

必需的属性

输出始终包含以下属性：

属性

desiredState

表示资源实例的所需状态。 DSC 根据资源的实例架构验证此属性的值。

Type:     object
Required: true

actualState

表示资源实例的实际状态。 DSC 根据资源的实例架构验证此属性的值。

Type:     object
Required: true

inDesiredState

指示资源实例的属性是否处于所需状态。 如果每个属性都处于所需状态，则此值为 true ;否则 false为 。

Type:     boolean
Required: true

differingProperties

定义未处于所需状态的属性的名称。 如果此值为空数组，则实例的属性处于所需状态。

Type:      array
Required:  true
ItemsType: string

完整测试结果

描述资源实例操作的完整结果的 test 返回数据。 返回此数据：

  • 对于使用 dsc config test 命令时配置文档中的每个实例。
  • 对于使用 dsc resource test 命令时组或适配器资源的嵌套实例。

必需的属性

属性

metadata

定义配置操作的元数据 DSC 返回。 属性下 Microsoft.DSC 的属性描述操作的上下文。

Type:     object
Required: true

类型

属性 type 通过其完全限定的类型名称标识实例的 DSC 资源。 有关类型名称的详细信息，请参阅 DSC 资源完全限定的类型名称架构参考。

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

name

属性 name 通过其简短的唯一人类可读名称来标识实例。

Type:     string
Required: true

result

属性 result 包括资源的验证状态。 此值为：

  • 实例的简单测试响应
  • 如果资源是组或适配器资源，则为每个嵌套实例的完整获取结果对象数组。
Type: [object, array]
Required: true