通过

dsc 配置测试结果架构参考

概要

dsc config test 命令的结果输出。

元数据

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

描述

dsc config test 命令的输出包括测试操作前后配置中每个资源实例的状态，以及每个实例的操作更改的属性列表。

必需属性

输出始终包括以下属性：

性能

元数据

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

Type:     object
Required: true

Microsoft.DSC

此属性下的元数据描述了整体操作的上下文：

  • 版本 定义运行命令的 DSC 版本。 此值始终是 DSC 命令的语义版本，如 3.0.0-preview.7。
  • 操作 定义 DSC 应用于配置文档的操作：Get、Set、Test或 Export。
  • executionType 定义 DSC 是实际应用于配置还是以 WhatIf 模式运行。 对于 Get、Test和 Export 操作，此属性始终 Actual。 对于 Set 操作，使用 --what-if 参数调用 DSC 时，将 WhatIf 此值。
  • startDatetime 将 DSC 操作的开始日期和时间定义为 RFC3339 第 5.6 节（见 date-time）中定义的格式（如 2024-04-14T08:49:51.395686600-07:00）的时间戳。
  • endDatetime 将 DSC 操作的结束日期和时间定义为 RFC3339 第 5.6 节（见 date-time）中定义的格式（如 2024-04-14T08:49:51.395686600-07:00）的时间戳。
  • 持续时间 将 DSC 操作针对配置文档或资源实例的持续时间定义为字符串，该字符串遵循 ISO8601 ABNF 中为 duration定义的格式。 例如，PT0.611216S 表示大约 0.61 秒的持续时间。
  • securityContext 定义 DSC 运行的安全上下文。 如果此元数据属性的值 Elevated，DSC 将作为 root（非 Windows）或提升的会话（在 Windows 上）运行。 如果该值 Restricted，DSC 在非提升的会话中作为普通用户或帐户运行。

结果

定义针对配置文档中每个实例调用的 test 操作的结果列表。 列表中的每个条目都包含资源的类型名称、实例名称和实例的结果数据。

Type:      array
Required:  true
ItemsType: object

类型

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

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

名字

项的 name 属性通过实例的简短、唯一且可读的名称来标识实例。

Type:     string
Required: true

结果

项的 result 属性包括资源实例的验证状态。 此属性的值遵循与 dsc resource test 命令的输出相同的架构。 有关详细信息，请参阅 dsc 资源测试结果架构参考。

消息

定义测试操作期间资源发出的结构化消息的列表。 有关详细信息，请参阅 结构化消息架构参考。

Type:     array
Required: true

hadErrors

指示操作是否遇到任何错误。 如果配置文档未通过验证或任何资源退出，则此值 true 除 0以外的退出代码。

Type:     boolean
Required: true