Policy Set Definition Versions - Create Or Update

サービス:: Policy

API バージョン:: 2025-11-01

この操作は、与えられたサブスクリプション内で名前とバージョンを含むポリシーセット定義バージョンを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2025-11-01

URI パラメーター

名前	/	必須	型	説明
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	ポリシーセット定義のバージョン。フォーマットはx.y.zで、xはメジャーバージョン番号、yはマイナーバージョン番号、zはパッチ番号です
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	ポリシーセット定義の名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.policyDefinitions	True	PolicyDefinitionReference[]	ポリシー定義参照の配列。
properties.description		string	ポリシーセット定義の説明。
properties.displayName		string	ポリシーセット定義の表示名。
properties.metadata			ポリシーセット定義メタデータ。メタデータはオープンエンドオブジェクトであり、通常はキーと値のペアのコレクションです。
properties.parameters		<string, ParameterDefinitionsValue>	ポリシー定義参照で使用できるポリシーセット定義パラメーター。
properties.policyDefinitionGroups		PolicyDefinitionGroup[]	ポリシーセット定義内のポリシー定義参照のグループを記述するメタデータ。
properties.policyType		PolicyType	ポリシー定義の種類。指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
properties.version		string	#.#.# 形式のポリシーセット定義のバージョン。

応答

名前	型	説明
200 OK	PolicySetDefinitionVersion	リソース「PolicySetDefinitionVersion」更新操作が成功しました
201 Created	PolicySetDefinitionVersion	リソース「PolicySetDefinitionVersion」作成操作が成功しました
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create or update a policy set definition version

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2025-11-01

{
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus"
      },
      {
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus"
      },
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

状態コード:: 201

{
  "name": "1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "parameters": {
      "namePrefix": {
        "type": "String",
        "defaultValue": "myPrefix",
        "metadata": {
          "displayName": "Prefix to enforce on resource names"
        }
      }
    },
    "policyDefinitions": [
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus"
      },
      {
        "definitionVersion": "1.*.*",
        "parameters": {
          "prefix": {
            "value": "[parameters('namePrefix')]"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ParameterDefinitionsValue	ポリシーに提供できるパラメータの定義。
ParameterDefinitionsValueMetadata	パラメーターの一般的なメタデータ。
ParameterType	パラメーターのデータ型。
ParameterValuesValue	パラメータの値。
PolicyDefinitionGroup	政策定義グループ。
PolicyDefinitionReference	ポリシー定義の参考文献。
PolicySetDefinitionVersion	ポリシーセット定義のバージョン。
PolicyType	ポリシー定義の種類。指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ParameterDefinitionsValue

Object

ポリシーに提供できるパラメータの定義。

名前	型	説明
allowedValues	AllowedValues[]	パラメーターに使用できる値。
defaultValue		値が指定されていない場合のパラメーターの既定値。
metadata	ParameterDefinitionsValueMetadata	パラメーターの一般的なメタデータ。
schema		自己定義 JSON スキーマを使用した割り当て時のパラメーター入力の検証を提供します。このプロパティはオブジェクト型パラメータのみをサポートし、Json.NET Schema 2019-09の実装に従っています。スキーマの使い方についてはhttps://json-schema.org/で、ドラフトスキーマのテストについてはhttps://www.jsonschemavalidator.net/で学べます。
type	ParameterType	パラメーターのデータ型。

ParameterDefinitionsValueMetadata

Object

パラメーターの一般的なメタデータ。

名前	型	説明
assignPermissions	boolean	ポリシー割り当て時に、AzureポータルがこのパラメータのリソースIDまたはリソーススコープ値に対してロール割り当てを作成するためにtrueに設定してください。このプロパティは、割り当てスコープ外でアクセス許可を割り当てる場合に便利です。
description	string	パラメーターの説明。
displayName	string	パラメーターの表示名。
strongType	string	ポータルを使用してポリシー定義を割り当てるときに使用されます。ユーザーが選択する値のコンテキスト対応リストを提供します。

ParameterType

列挙

パラメーターのデータ型。

値	説明
String	文字列パラメータタイプです。
Array	配列パラメータ型。
Object	オブジェクトパラメータタイプです。
Boolean	ブールパラメータ型。
Integer	整数パラメータ型です。
Float	floatパラメータ型です。
DateTime	日付-時刻パラメータ型です。

ParameterValuesValue

Object

パラメータの値。

名前	型	説明
value		パラメーターの値。

PolicyDefinitionGroup

Object

政策定義グループ。

名前	型	説明
additionalMetadataId	string	グループに関する追加のメタデータを含むリソースのリソース ID。
category	string	グループのカテゴリ。
description	string	グループの説明。
displayName	string	グループの表示名。
name	string	グループの名前を指定します。

PolicyDefinitionReference

Object

ポリシー定義の参考文献。

名前	型	説明
definitionVersion	string	使用するポリシー定義のバージョン。
effectiveDefinitionVersion	string	使用されている政策定義の実効バージョン。これは$expandクエリパラメータでリクエストされた場合のみ存在します。
groupNames	string[]	このポリシー定義が参照するグループの名前。
latestDefinitionVersion	string	最新のポリシー定義が利用可能です。これは$expandクエリパラメータでリクエストされた場合のみ存在します。
parameters	<string, ParameterValuesValue>	参照されるポリシー規則のパラメーター値。キーはパラメーター名です。
policyDefinitionId	string	ポリシー定義またはポリシーセット定義の ID。
policyDefinitionReferenceId	string	このポリシー定義参照の一意の ID (ポリシーセット定義内)。

PolicySetDefinitionVersion

Object

ポリシーセット定義のバージョン。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.description	string	ポリシーセット定義の説明。
properties.displayName	string	ポリシーセット定義の表示名。
properties.metadata		ポリシーセット定義メタデータ。メタデータはオープンエンドオブジェクトであり、通常はキーと値のペアのコレクションです。
properties.parameters	<string, ParameterDefinitionsValue>	ポリシー定義参照で使用できるポリシーセット定義パラメーター。
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	ポリシーセット定義内のポリシー定義参照のグループを記述するメタデータ。
properties.policyDefinitions	PolicyDefinitionReference[]	ポリシー定義参照の配列。
properties.policyType	PolicyType	ポリシー定義の種類。指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
properties.version	string	#.#.# 形式のポリシーセット定義のバージョン。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PolicyType

列挙

ポリシー定義の種類。指定できる値は、NotSpecified、BuiltIn、Custom、Static です。

値	説明
NotSpecified	未指定のポリシー定義タイプ。
BuiltIn	組み込みのポリシー定義タイプ。
Custom	カスタムポリシー定義タイプ。
Static	静的ポリシー定義タイプ。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Policy Set Definition Versions - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create or update a policy set definition version

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

ParameterType

ParameterValuesValue

PolicyDefinitionGroup

PolicyDefinitionReference

PolicySetDefinitionVersion

PolicyType

systemData