次の方法で共有

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

  • [アーティクル]

概要

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

メタデータ

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

形容

dsc resource list コマンドからの出力には、検出された DSC リソースの一連の JSON 行表現が含まれます。 このスキーマでは、各リソースに対して返される JSON オブジェクトについて説明します。

必須プロパティ

出力内の各リソースには、常に次のプロパティが含まれます。

プロパティ

種類

リソースの完全修飾型名を識別します。 dsc resource * コマンドを使用する場合は、構成ドキュメントでリソースを指定し、--resource フラグの値として指定するために使用されます。 リソースの種類名の詳細については、「DSC リソースの完全修飾型名スキーマ リファレンスを参照してください。

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

種類

リソースが アダプター リソース、グループ リソース、どちらであるかを識別します。 この値は、リソース マニフェスト で定義されるか、DSC によって推論されます。 リソースの種類の詳細については、「DSC リソースの種類のスキーマ リファレンスを参照してください。

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

バージョン

有効なセマンティック バージョン (semver) 文字列として、リソースの現在のバージョンを表します。 バージョンは、管理するソフトウェアではなく、リソースに適用されます。

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

資格

リソースがサポートするために実装される操作と動作を定義します。 このプロパティは、機能の配列です。 リソースには常に Get 機能がありますが、その他の機能は省略可能であり、リソースによって異なります。

次の一覧では、リソースで使用できる機能について説明します。

  • Get - リソースは、インスタンスの現在の状態の取得をサポートします。 すべての DSC リソースには、この機能が必要です。 リソースには、リソース マニフェストで必須のプロパティを取得 定義する場合に、この機能があります。

  • Set - リソースは、インスタンスの目的の状態の適用をサポートします。 リソース は、リソース マニフェストでプロパティ 設定 を定義するときに、この機能を備えます。 この機能を持たないリソースは、入れ子になったインスタンスとして Microsoft.DSC/Assertion グループ内に存在しない限り、dsc リソース セット または dsc 構成セット コマンドで使用することはできません。

  • SetHandlesExist - リソースは、_exist プロパティ 直接サポートします。 リソース には、リソース マニフェストのコマンド プロパティ 設定 の定義に として handlesExist プロパティが定義されている場合に、この機能があります。

    リソースにこの機能がある場合、_exist プロパティはリソースのインスタンス スキーマの一部であり、リソースはその set コマンドでリソースのインスタンスの削除を処理します。

    リソースにこの機能がない場合、DSC は、_exist が falseに設定されたリソースのインスタンスを検出すると、リソースの 削除 操作の呼び出しを処理します。

    リソースにこの機能または Delete 機能がない場合、インスタンスが falseとして _exist を定義すると、DSC によってエラーが発生します。

  • - リソースは、ユーザーが --what-if オプションを使用して dsc 構成セット 呼び出したときの状態の変更方法に関する明示的な情報の返しをサポートします。 リソースには、リソース マニフェストで What-if メソッドを定義するときに、この機能があります。

    リソースにこの機能がある場合、ユーザーが --what-if オプションを指定して dsc config set コマンドを実行すると、DSC は定義されたコマンドを引数で呼び出します。

    リソースにこの機能がない場合、DSC は、インスタンスの Test の結果を Set の結果に変換することで、リソースの変更方法とインスタンスを合成します。 合成操作は、Test 操作の結果をリソースの目的の状態と比較することによって判断できない潜在的な問題や変更を示すことはできません。 たとえば、リソースのテストに使用される資格情報は、その操作に対して有効ですが、システムの状態を実際に変更するためのアクセス許可がない場合があります。 この機能を持つリソースのみが、リソースがシステム状態を変更するかどうかとその方法を完全に報告できます。

  • Test - リソースは、インスタンスの現在の状態に対するインスタンスの目的の状態の検証をサポートします。 リソースには、リソース マニフェストで テスト プロパティを定義するときに、この機能があります。

    リソースに Test 機能がない場合、DSC はリソースのインスタンスに対して合成テストを使用します。 合成テストでは、インスタンスの目的の状態の各プロパティが実際の状態と比較されます。 合成テストでは、大文字と小文字が区別される厳密な等価性が使用されます。 プロパティの目的の状態と実際の状態が同じでない場合、DSC はプロパティを目的の状態から外れた状態としてマークします。

  • Delete - リソースはインスタンスの削除をサポートします。 リソースには、リソース マニフェストで delete プロパティを定義するときに、この機能があります。 この機能は、SetHandlesExist プロパティと相互に排他的ではありません。 リソースは、セット操作で _exist プロパティを処理し、dsc リソースの削除 を使用して直接呼び出してインスタンスを削除できます。

  • Export - リソースは、リソースのすべてのインスタンスの列挙をサポートします。 リソースには、リソース マニフェストで export プロパティを定義するときに、この機能があります。 この機能を持つリソースのみが、dsc リソース エクスポート および dsc 構成エクスポート コマンドで使用できます。

  • Resolve - リソースは、外部ソースからの入れ子になったリソース インスタンスの解決をサポートします。 リソースは、リソース マニフェストで 解決 プロパティを定義するときに、この機能を備えます。 この機能は主に、インポーター リソースによって使用されます。

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [Get, Set, SetHandlesExist, Test, Delete, Export]

形容

リソースの目的の概要を短い文字列として定義します。 リソースに説明がない場合、このプロパティは nullです。

Type:     [string, 'null']
Required: true

パス

マシン上のリソースのマニフェストへのパスを表します。 適応型リソースの場合、このプロパティは、代わりにリソースを定義するファイルへのパスを識別します。

Type:     string
Required: true

ディレクトリ

コンピューター上のリソースのマニフェストを含むフォルダーへのパスを表します。 適応型リソースの場合、このプロパティは、代わりにリソースを定義するファイルを含むフォルダーへのパスを識別します。

Type:     string
Required: true

implementedAs

DSC リソースの実装方法を示します。 コマンド ベースのリソースの場合、この値は常に Command。

著者

DSC リソースを開発および管理するユーザーまたは組織の名前を示します。 このプロパティが nullされている場合、作成者は不明です。

Type:     [string, 'null']
Required: true

プロパティ

適合リソースのプロパティ名を定義します。 適合していないリソースの場合、このプロパティは空の配列です。

Type:         array
Required:     true
ItemsType:    string
ItemsPattern: ^\w+$

requireAdapter

このリソースを使用できるようにする DSC リソース アダプターの完全修飾型名を定義します。 この値は、適合したリソースに対してのみ定義されます。 非適合リソースの場合、この値は常に null。

Type:     [string, 'null']
Required: true

積荷目録

リソースのマニフェストで定義されている値を表します。 この値は、コマンド ベースではないリソースに対して null されます。 このプロパティの値の詳細については、「コマンド ベースの DSC リソース マニフェスト スキーマリファレンス参照してください。

Type:     [object, 'null']
Required: true