Microsoft.Authorization policyAssignments 2022-06-01
Bicep リソース定義
policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを scope
設定するには、このリソースの プロパティを使用します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
policyAssignments リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyAssignments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Authorization/policyAssignments@2022-06-01' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
description: 'string'
displayName: 'string'
enforcementMode: 'string'
metadata: any()
nonComplianceMessages: [
{
message: 'string'
policyDefinitionReferenceId: 'string'
}
]
notScopes: [
'string'
]
overrides: [
{
kind: 'policyEffect'
selectors: [
{
in: [
'string'
]
kind: 'string'
notIn: [
'string'
]
}
]
value: 'string'
}
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
resourceSelectors: [
{
name: 'string'
selectors: [
{
in: [
'string'
]
kind: 'string'
notIn: [
'string'
]
}
]
}
]
}
}
プロパティ値
policyAssignments
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
location | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | string |
scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
identity | ポリシーの割り当てに関連付けられているマネージド ID。 | ID |
properties | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties |
ID
名前 | 説明 | 値 |
---|---|---|
type | ID の種類。 これは、システムまたはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。 | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | ポリシーに関連付けられているユーザー ID。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PolicyAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
description | このメッセージは、ポリシー違反が発生した場合の応答の一部になります。 | string |
displayName | ポリシー割り当ての表示名。 | string |
enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | 'Default' 'DoNotEnforce' |
metadata | ポリシー割り当てメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。 | Bicep の場合は、 any() 関数を使用できます。 |
nonComplianceMessages | リソースがポリシーに準拠していない理由を示すメッセージ。 | NonComplianceMessage[] |
notScopes | ポリシーの除外されたスコープ。 | string[] |
上書き | ポリシー プロパティ値のオーバーライド。 | Override[] |
parameters | 割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。 | ParameterValues |
policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | string |
resourceSelectors | リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。 | ResourceSelector[] |
NonComplianceMessage
名前 | 説明 | 値 |
---|---|---|
message | リソースがポリシーに準拠していない理由を示すメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンス結果に表示されます。 | string (必須) |
policyDefinitionReferenceId | メッセージの対象となるポリシー・セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、このポリシー割り当てによって割り当てられたすべてのポリシーにメッセージが適用されます。 | string |
オーバーライド
名前 | 説明 | 値 |
---|---|---|
kind | オーバーライドの種類。 | 'policyEffect' |
selectors | セレクター式の一覧。 | Selector[] |
value | ポリシー プロパティをオーバーライドする値。 | string |
セレクター
名前 | 説明 | 値 |
---|---|---|
in | フィルター処理する値の一覧。 | string[] |
kind | セレクターの種類。 | 'policyDefinitionReferenceId' 'resourceLocation' 'resourceType' 'resourceWithoutLocation' |
notIn | 除外する値の一覧。 | string[] |
ParameterValues
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
名前 | 説明 | 値 |
---|---|---|
value | パラメーターの値。 | Bicep の場合は、 any() 関数を使用できます。 |
ResourceSelector
名前 | 説明 | 値 |
---|---|---|
name | リソース セレクターの名前。 | string |
selectors | セレクター式の一覧。 | Selector[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
ポリシー定義を展開し、管理グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。 |
ポリシー Def を展開し、複数の Mgmt グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
組み込みポリシーを既存のリソース グループに割り当てる |
このテンプレートは、組み込みのポリシーを既存のリソース グループに割り当てます。 |
Azure Virtual Network Manager とサンプル VNET をCreateする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類がサポートされています。 |
ARM テンプレート リソース定義
policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを scope
設定するには、このリソースの プロパティを使用します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
policyAssignments リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyAssignments リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.Authorization/policyAssignments",
"apiVersion": "2022-06-01",
"name": "string",
"location": "string",
"scope": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"description": "string",
"displayName": "string",
"enforcementMode": "string",
"metadata": {},
"nonComplianceMessages": [
{
"message": "string",
"policyDefinitionReferenceId": "string"
}
],
"notScopes": [ "string" ],
"overrides": [
{
"kind": "policyEffect",
"selectors": [
{
"in": [ "string" ],
"kind": "string",
"notIn": [ "string" ]
}
],
"value": "string"
}
],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"resourceSelectors": [
{
"name": "string",
"selectors": [
{
"in": [ "string" ],
"kind": "string",
"notIn": [ "string" ]
}
]
}
]
}
}
プロパティ値
policyAssignments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Authorization/policyAssignments' |
apiVersion | リソース API のバージョン | '2022-06-01' |
name | リソース名 | string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
location | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | string |
scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定 します 。 |
identity | ポリシー割り当てに関連付けられているマネージド ID。 | ID |
properties | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties |
ID
名前 | 説明 | 値 |
---|---|---|
type | ID の種類。 これは、システムまたはユーザー割り当て ID をリソースに追加する場合に必要な唯一のフィールドです。 | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | ポリシーに関連付けられているユーザー ID。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PolicyAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
description | このメッセージは、ポリシー違反の場合の応答の一部になります。 | string |
displayName | ポリシー割り当ての表示名。 | string |
enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | 'Default' 'DoNotEnforce' |
metadata | ポリシー割り当てメタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
nonComplianceMessages | リソースがポリシーに準拠していない理由を示すメッセージ。 | NonComplianceMessage[] |
notScopes | ポリシーの除外されたスコープ。 | string[] |
上書き | ポリシー プロパティの値のオーバーライド。 | Override[] |
parameters | 割り当てられたポリシー 規則のパラメーター値。 キーはパラメーター名です。 | ParameterValues |
policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | string |
resourceSelectors | リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。 | ResourceSelector[] |
NonComplianceMessage
名前 | 説明 | 値 |
---|---|---|
message | リソースがポリシーに準拠していない理由を示すメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。 | string (必須) |
policyDefinitionReferenceId | メッセージが意図されているポリシー・セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。 | string |
オーバーライド
名前 | 説明 | 値 |
---|---|---|
kind | オーバーライドの種類。 | 'policyEffect' |
selectors | セレクター式の一覧。 | Selector[] |
value | ポリシー プロパティをオーバーライドする値。 | string |
セレクター
名前 | 説明 | 値 |
---|---|---|
in | フィルター処理する値の一覧。 | string[] |
kind | セレクターの種類。 | 'policyDefinitionReferenceId' 'resourceLocation' 'resourceType' 'resourceWithoutLocation' |
notIn | フィルター処理する値の一覧。 | string[] |
ParameterValues
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
名前 | 説明 | 値 |
---|---|---|
value | パラメーターの値。 |
ResourceSelector
名前 | 説明 | 値 |
---|---|---|
name | リソース セレクターの名前。 | string |
selectors | セレクター式の一覧。 | Selector[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
ポリシー定義を展開して管理グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイできません。 |
複数の Mgmt グループにポリシーの遅延と割り当てを展開する |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
組み込みのポリシーを既存のリソース グループに割り当てる |
このテンプレートは、組み込みのポリシーを既存のリソース グループに割り当てます。 |
Azure Virtual Network Manager とサンプル VNET をCreateする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類がサポートされています。 |
Terraform (AzAPI プロバイダー) リソース定義
policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを parent_id
使用して、このリソースのスコープを設定します。
policyAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ
- サブスクリプション
- 管理グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyAssignments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyAssignments@2022-06-01"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
description = "string"
displayName = "string"
enforcementMode = "string"
nonComplianceMessages = [
{
message = "string"
policyDefinitionReferenceId = "string"
}
]
notScopes = [
"string"
]
overrides = [
{
kind = "policyEffect"
selectors = [
{
in = [
"string"
]
kind = "string"
notIn = [
"string"
]
}
]
value = "string"
}
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
resourceSelectors = [
{
name = "string"
selectors = [
{
in = [
"string"
]
kind = "string"
notIn = [
"string"
]
}
]
}
]
}
})
}
プロパティ値
policyAssignments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Authorization/policyAssignments@2022-06-01" |
name | リソース名 | string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
location | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | string |
parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
identity | ポリシーの割り当てに関連付けられているマネージド ID。 | ID |
properties | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties |
ID
名前 | 説明 | 値 |
---|---|---|
type | ID の種類。 これは、システムまたはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。 | "SystemAssigned" "UserAssigned" |
identity_ids | ポリシーに関連付けられているユーザー ID。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 | ユーザー ID ID の配列。 |
IdentityUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PolicyAssignmentProperties
名前 | 説明 | 値 |
---|---|---|
description | このメッセージは、ポリシー違反が発生した場合の応答の一部になります。 | string |
displayName | ポリシー割り当ての表示名。 | string |
enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | "Default" "DoNotEnforce" |
metadata | ポリシー割り当てメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
nonComplianceMessages | リソースがポリシーに準拠していない理由を示すメッセージ。 | NonComplianceMessage[] |
notScopes | ポリシーの除外されたスコープ。 | string[] |
上書き | ポリシー プロパティ値のオーバーライド。 | Override[] |
parameters | 割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。 | ParameterValues |
policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | string |
resourceSelectors | リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。 | ResourceSelector[] |
NonComplianceMessage
名前 | 説明 | 値 |
---|---|---|
message | リソースがポリシーに準拠していない理由を示すメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンス結果に表示されます。 | string (必須) |
policyDefinitionReferenceId | メッセージの対象となるポリシー・セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、このポリシー割り当てによって割り当てられたすべてのポリシーにメッセージが適用されます。 | string |
オーバーライド
名前 | 説明 | 値 |
---|---|---|
kind | オーバーライドの種類。 | "policyEffect" |
selectors | セレクター式の一覧。 | Selector[] |
value | ポリシー プロパティをオーバーライドする値。 | string |
セレクター
名前 | 説明 | 値 |
---|---|---|
in | フィルター処理する値の一覧。 | string[] |
kind | セレクターの種類。 | "policyDefinitionReferenceId" "resourceLocation" "resourceType" "resourceWithoutLocation" |
notIn | 除外する値の一覧。 | string[] |
ParameterValues
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
名前 | 説明 | 値 |
---|---|---|
value | パラメーターの値。 |
ResourceSelector
名前 | 説明 | 値 |
---|---|---|
name | リソース セレクターの名前。 | string |
selectors | セレクター式の一覧。 | Selector[] |