DSC リソース _exist プロパティ スキーマ

概要

インスタンスが存在するかどうかを示します。

メタデータ

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json
Type:          boolean
DefaultValue:  true

説明

プロパティは _exist 、リソースがインスタンスが存在するかどうか、セット操作中にインスタンスを追加、更新、または削除するかどうかを処理することを強制できることを示します。 このプロパティは、DSC リソースと統合ツールの共有セマンティクスを提供しますが、DSC を使用した追加の組み込み処理は有効になりません。

リソースでは、実装が次の動作コントラクトに準拠している場合にのみ、このプロパティを定義する必要があります。

1. の目的の状態 _exist が の true場合、リソースはインスタンスが存在することを想定します。 存在しない場合、リソースはセット操作中にインスタンスを作成または追加します。

2. の目的の状態 _exist が の false場合、リソースはインスタンスが存在しないことを想定します。 存在する場合、リソースはセット操作中にインスタンスを削除または削除します。

3. get 操作が存在しないインスタンスに対してクエリを実行すると、返される JSON は常に プロパティを _exist として false定義します。

   インスタンス が 存在する場合、リソースは結果 JSON から プロパティを省略 _exist できます。

このプロパティをリソースのインスタンス スキーマに追加するには、次のスニペットを使用して プロパティを定義します。

"_exist": {
  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json"
}