Policy Assignments - Create By Id

サービス:: Policy

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

ポリシー割り当てを作成または更新します。
この操作は与えられたIDでポリシー割り当てを作成または更新します。スコープ上で行われたポリシー割り当ては、そのスコープに含まれるすべてのリソースに適用されます。例えば、リソースグループにポリシーを割り当てるとき、そのポリシーはグループ内のすべてのリソースに適用されます。ポリシー割り当てIDのフォーマットは次のです:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。有効なスコープは、管理グループ(フォーマット:'/providers/Microsoft.Management/managementGroups/{managementGroup}')、サブスクリプション(フォーマット:'/subscriptions/{subscriptionId}')、リソースグループ(フォーマット:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース(フォーマット:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'')です。

PUT https://management.azure.com/{policyAssignmentId}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
policyAssignmentId	path	True	string	作成するポリシー割り当てのIDです。 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の形式を使用します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	Identity	ポリシーの割り当てに関連付けられているマネージド ID。
location	string	ポリシー割り当ての場所。マネージド ID を使用する場合にのみ必要です。
properties.assignmentType	assignmentType	ポリシー割り当ての種類。指定できる値は、NotSpecified、System、SystemHidden、Custom です。不変です。
properties.definitionVersion	string	使用するポリシー定義のバージョン。
properties.description	string	このメッセージは、ポリシー違反が発生した場合の応答の一部になります。
properties.displayName	string	ポリシー割り当ての表示名。
properties.enforcementMode	enforcementMode	ポリシー割り当て適用モード。使用できる値は、既定値、DoNotEnforce、および登録です
properties.metadata	object	ポリシー割り当てのメタデータ。メタデータはオープンエンドオブジェクトであり、通常はキーと値のペアのコレクションです。
properties.nonComplianceMessages	NonComplianceMessage[]	リソースがポリシーに準拠していない理由を説明するメッセージ。
properties.notScopes	string[]	ポリシーの除外されたスコープ。
properties.overrides	Override[]	ポリシープロパティ値のオーバーライド。
properties.parameters	<string, ParameterValuesValue>	割り当てられたポリシールールのパラメーター値。キーはパラメーター名です。
properties.policyDefinitionId	string	割り当てられているポリシー定義またはポリシーセット定義の ID。
properties.resourceSelectors	ResourceSelector[]	リソースのプロパティでポリシーをフィルター処理するリソースセレクターの一覧。

応答

名前	型	説明
201 Created	PolicyAssignment	作成済み - ポリシー割り当てに関する情報を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

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

スコープ

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

例

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

要求のサンプル

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

応答のサンプル

状態コード:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

要求のサンプル

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2025-01-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

応答のサンプル

状態コード:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

定義

名前	説明
assignmentType	ポリシー割り当ての種類。指定できる値は、NotSpecified、System、SystemHidden、Custom です。不変です。
CloudError	ポリシー操作からのエラー応答。
createdByType	リソースを作成した ID の種類。
enforcementMode	ポリシー割り当て適用モード。使用できる値は、既定値、DoNotEnforce、および登録です
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
Identity	リソースの ID。ポリシー割り当ては最大1つのアイデンティティをサポートします。それはシステム割り当てのアイデンティティか、単一ユーザー割り当てのアイデンティティのいずれかです。
NonComplianceMessage	リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。
Override	ポリシープロパティ値のオーバーライド。
OverrideKind	オーバーライドの種類。
ParameterValuesValue	パラメータの値。
PolicyAssignment	政策の割り当て。
ResourceIdentityType	ID の種類。これは、システム割り当て ID またはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。
ResourceSelector	リソースプロパティでポリシーをフィルター処理するリソースセレクター。
Selector	セレクター式。
SelectorKind	セレクターの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

assignmentType

列挙

ポリシー割り当ての種類。指定できる値は、NotSpecified、System、SystemHidden、Custom です。不変です。

値	説明
NotSpecified
System
SystemHidden
Custom

CloudError

Object

ポリシー操作からのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

enforcementMode

列挙

ポリシー割り当て適用モード。使用できる値は、既定値、DoNotEnforce、および登録です

値	説明
Default	ポリシーの効果は、リソースの作成時または更新時に適用されます。
DoNotEnforce	このポリシー効果はリソース作成や更新時に強制されません。
Enroll	ポリシー効果は、リソースの作成や更新時に、リソースやリソースのスコープが割り当てインスタンスに登録されるまで強制されません。加入はポリシー登録リソースの展開時に行われます。

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

エラー応答

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

Identity

Object

リソースの ID。ポリシー割り当ては最大1つのアイデンティティをサポートします。それはシステム割り当てのアイデンティティか、単一ユーザー割り当てのアイデンティティのいずれかです。

名前	型	説明
principalId	string	リソース識別子の主IDです。このプロパティはシステムに割り当てられたアイデンティティにのみ提供されます
tenantId	string	リソース識別のテナントID。このプロパティはシステムに割り当てられたアイデンティティにのみ提供されます
type	ResourceIdentityType	ID の種類。これは、システム割り当て ID またはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。
userAssignedIdentities	UserAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

NonComplianceMessage

Object

リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。

名前	型	説明
message	string	リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。
policyDefinitionReferenceId	string	メッセージの対象となるポリシーセット定義内のポリシー定義参照 ID。これは、ポリシー割り当てによってポリシーセット定義が割り当てられている場合にのみ適用されます。これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。

Override

Object

ポリシープロパティ値のオーバーライド。

名前	型	説明
kind	OverrideKind	オーバーライドの種類。
selectors	Selector[]	セレクター式の一覧。
value	string	ポリシープロパティをオーバーライドする値。

OverrideKind

列挙

オーバーライドの種類。

値	説明
policyEffect	ポリシー効果タイプを上書きします。
definitionVersion	ポリシー割り当ての定義バージョンプロパティ値を上書きします。

ParameterValuesValue

Object

パラメータの値。

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