次の方法で共有

DSC リソース マニフェスト アダプターのプロパティ スキーマ リファレンス

  • [アーティクル]

概要

DSC リソースを DSC リソース アダプターとして定義します。

メタデータ

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

説明

DSC リソース アダプターは、マニフェストで プロパティを adapter 定義する必要があります。 このプロパティは、リソースをアダプターとして識別し、DSC がアダプターを呼び出してアダプターがサポートするリソースを取得する方法と、アダプターにリソース インスタンスを渡す方法を定義します。

例

例 1 - Microsoft.DSC/PowerShell

この例は、DSC リソース アダプターの Microsoft.DSC/PowerShell 例です。

"adapter": {
  "list": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-Command",
      "./powershell.resource.ps1 List"
    ]
    },
  "config": "full"
},

マニフェストは にfull設定configされます。これは、アダプターが からのstdin完全な構成と未処理の構成を表す JSON BLOB を想定していることを示します。

として定義されますlist.executablepwsh。 で定義されている引数を使用すると、DSC で list.args PowerShell が実行されます。

  • ロゴ バナーなし
  • 非対話型モード
  • プロファイル スクリプトを読み込まない
  • コマンドと同じフォルダーdsc内のスクリプトを呼び出powershell.resource.ps1し、 引数をList渡します。

この定義では、DSC は次を list 実行して、このアダプターの メソッドを呼び出します。

pwsh -NoLogo -NonInteractive -NoProfile -Command "./powershellgroup.resource.ps1 List"

必須プロパティ

定義には、 adapter 次のプロパティを含める必要があります。

プロパティ

config

プロパティは config 、アダプターがリソース構成を受け取る方法を定義します。 値は、次のいずれかのオプションである必要があります。

  • full - アダプターが、完全な構成と未処理の構成を含む JSON BLOB を、 経由 stdinの単一の JSON BLOB として想定していることを示します。
  • sequence - アダプターが各リソースの構成を JSON Line over stdinとして想定していることを示します。
Type:        string
ValidValues: [full, sequence]

list

プロパティは list 、アダプターを呼び出して、サポートされているリソースを一覧表示する方法を定義します。 このプロパティの値は オブジェクトであり、サブプロパティを定義する executable 必要があります。

Type:               object
Required:           true
RequiredProperties: [executable]

executable

サブプロパティは executable 、実行するコマンドの名前を定義します。 値は、システムの環境変数で検出可能なコマンドの PATH 名前、またはコマンドの完全パスである必要があります。 ファイル拡張子は、コマンドがオペレーティング システムで実行可能ファイルとして認識できない場合にのみ必要です。

Type:     string
Required: true

args

サブプロパティは args 、コマンドに引数として渡す文字列の配列を定義します。 DSC は、指定された順序でコマンドに引数を渡します。

Type:     array
Required: false
Default:  []