dsc リソース テスト結果スキーマ リファレンス

概要

コマンドからの結果の dsc resource test 出力。

メタデータ

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

説明

コマンドからの dsc resource get DSC リソース インスタンスの戻りデータについて説明します。 戻りデータは、入れ子になっていないインスタンスのテスト済み状態を表す単一のオブジェクトか、グループまたはアダプター リソースの入れ子になったインスタンスのテスト済み状態を記述する オブジェクトの配列です。

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 プロパティは、操作のコンテキストを記述します。

  • duration は、構成ドキュメントまたはリソース インスタンスに対する DSC 操作の期間を、 の ABNF durationで定義ISO8601形式に従う文字列として定義します。 たとえば、 PT0.611216S は約 0.61 秒の期間を表します。
Type:     object
Required: true

型

プロパティは type 、インスタンスの DSC リソースを完全修飾型名で識別します。 型名の詳細については、「 DSC リソースの完全修飾型名スキーマ リファレンス」を参照してください。

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

name

プロパティは name 、人間が判読できる短い一意の名前でインスタンスを識別します。

Type:     string
Required: true

結果

プロパティには result 、リソースの検証状態が含まれます。 この値は次のいずれかです。

  • インスタンスの単純なテスト応答
  • リソースがグループまたはアダプター リソースの場合、入れ子になった各インスタンスの完全な取得結果オブジェクトの配列。
Type: [object, array]
Required: true
  • Last updated on