次の方法で共有

dsc リソース セットの結果スキーマリファレンス

  • [アーティクル]

概要

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

メタデータ

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

説明

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

DSC は、インスタンスがグループ リソース、アダプター リソース、またはグループまたはアダプター リソース内に入れ子になっていない場合に、 単純なセット応答 を返します。

取得したインスタンスがグループ リソース、アダプター リソース、またはグループまたはアダプター リソース内に入れ子になっている場合、DSC は 完全なセットの結果を返します。これには、リソースの種類とインスタンス名も含まれます。

単純なセット応答

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

必須プロパティ

出力には常に次のプロパティが含まれます。

プロパティ

beforeState

設定操作の前に返されるインスタンスの状態を表します。 DSC は、リソースのインスタンス スキーマに対してこのプロパティの値を検証します。

Type:     object
Required: true

afterState

設定操作の後に返されるインスタンスの状態を表します。 DSC は、リソースのインスタンス スキーマに対してこのプロパティの値を検証します。

Type:     object
Required: true

changedProperties

設定操作によって適用されるプロパティの名前を定義します。 この値が空の配列の場合、リソースは設定操作中に変更を加えなくなりました。

Type:      array
Required:  true
ItemsType: string

完全なセットの結果

リソース インスタンスの操作の完全な結果の set 戻りデータについて説明します。 このデータが返されます。

  • コマンドを使用する場合は、構成ドキュメント内のすべてのインスタンスについて dsc config set 。
  • コマンドを使用する場合に、グループまたはアダプター リソースの入れ子になったインスタンスの dsc resource set 場合。

必須プロパティ

プロパティ

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