Microsoft.Authorization policyAssignments 2021-06-01
- 最新の を
する - 2024-04-01
- 2023-04-01
- 2022-06-01
- 2021-06-01
- 2020-09-01
Bicep リソース定義
policyAssignments リソースの種類は、拡張機能リソースです。つまり、別のリソースに適用できます。
このリソースの scope プロパティを使用して、このリソースのスコープを設定します。 Bicepの拡張機能リソースのスコープの設定
policyAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
- サブスクリプションの - サブスクリプションのデプロイ コマンド 参照
- 管理グループの - 管理グループの展開コマンドを参照してください
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Authorization/policyAssignments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Authorization/policyAssignments@2021-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'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
}
}
プロパティ値
policyAssignments
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | string (必須) 文字制限: 1 ~ 128 表示名 1 から 64 リソース名 管理グループ スコープでの 1 から 24 個のリソース名 有効な文字: 表示名には任意の文字を含めることができます。 リソース名では、次の情報を使用できません。 <>*%&:\?.+/ または制御文字。 ピリオドまたはスペースで終えることはできません。 |
| 場所 | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | 糸 |
| スコープ | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して、拡張リソース適用します。 |
| 同一性 | ポリシーの割り当てに関連付けられているマネージド ID。 | ID |
| プロパティ | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties の |
同一性
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | ID の種類。 これは、システム割り当て 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
| 名前 | 形容 | 価値 |
|---|---|---|
| 形容 | このメッセージは、ポリシー違反が発生した場合の応答の一部になります。 | 糸 |
| displayName | ポリシー割り当ての表示名。 | 糸 |
| enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | 'Default' 'DoNotEnforce' |
| metadata | ポリシー割り当てのメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。 | Bicep の場合は、any() 関数を使用できます。 |
| nonComplianceMessages | リソースがポリシーに準拠していない理由を説明するメッセージ。 | NonComplianceMessage[] |
| notScopes | ポリシーの除外されたスコープ。 | string[] |
| パラメーター | 割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | 糸 |
NonComplianceMessage
| 名前 | 形容 | 価値 |
|---|---|---|
| メッセージ | リソースがポリシーに準拠していない理由を説明するメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。 | string (必須) |
| policyDefinitionReferenceId | メッセージの対象となるポリシー セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。 | 糸 |
ParameterValues
| 名前 | 形容 | 価値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 形容 | 価値 |
|---|---|---|
| 価値 | パラメーターの値。 | Bicep の場合は、any() 関数を使用できます。 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
ポリシー定義を展開し、管理グループ に割り当てる Azure にデプロイする |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。 |
|
ポリシー Def を展開し、複数の Mgmt グループに割り当てる Azure にデプロイする |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
|
組み込みポリシーを既存のリソース グループ に割り当てる Azure にデプロイする |
このテンプレートは、組み込みのポリシーを既存のリソース グループに割り当てます。 |
|
VM マネージド ディスクを監査する組み込みポリシーを割り当 Azure にデプロイする |
このテンプレートでは、組み込みのポリシーをリソース グループ スコープに割り当てて、仮想マシン (VM) マネージド ディスクを監査します。 |
|
Azure Virtual Network Manager とサンプル VNET を作成する Azure にデプロイする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類をサポートします。 |
ARM テンプレート リソース定義
policyAssignments リソースの種類は、拡張機能リソースです。つまり、別のリソースに適用できます。
このリソースの scope プロパティを使用して、このリソースのスコープを設定します。 「ARM テンプレートの拡張機能リソースのスコープを設定する」を参照してください。
policyAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
- サブスクリプションの - サブスクリプションのデプロイ コマンド 参照
- 管理グループの - 管理グループの展開コマンドを参照してください
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Authorization/policyAssignments リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Authorization/policyAssignments",
"apiVersion": "2021-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" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string"
}
}
プロパティ値
policyAssignments
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | 'Microsoft.Authorization/policyAssignments' |
| apiVersion | リソース API のバージョン | '2021-06-01' |
| 名前 | リソース名 | string (必須) 文字制限: 1 ~ 128 表示名 1 から 64 リソース名 管理グループ スコープでの 1 から 24 個のリソース名 有効な文字: 表示名には任意の文字を含めることができます。 リソース名では、次の情報を使用できません。 <>*%&:\?.+/ または制御文字。 ピリオドまたはスペースで終えることはできません。 |
| 場所 | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | 糸 |
| スコープ | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合、拡張機能リソースの を適用するリソースの完全な名前に値を設定します。 |
| 同一性 | ポリシーの割り当てに関連付けられているマネージド ID。 | ID |
| プロパティ | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties の |
同一性
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | ID の種類。 これは、システム割り当て 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
| 名前 | 形容 | 価値 |
|---|---|---|
| 形容 | このメッセージは、ポリシー違反が発生した場合の応答の一部になります。 | 糸 |
| displayName | ポリシー割り当ての表示名。 | 糸 |
| enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | 'Default' 'DoNotEnforce' |
| metadata | ポリシー割り当てのメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。 | |
| nonComplianceMessages | リソースがポリシーに準拠していない理由を説明するメッセージ。 | NonComplianceMessage[] |
| notScopes | ポリシーの除外されたスコープ。 | string[] |
| パラメーター | 割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | 糸 |
NonComplianceMessage
| 名前 | 形容 | 価値 |
|---|---|---|
| メッセージ | リソースがポリシーに準拠していない理由を説明するメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。 | string (必須) |
| policyDefinitionReferenceId | メッセージの対象となるポリシー セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。 | 糸 |
ParameterValues
| 名前 | 形容 | 価値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 形容 | 価値 |
|---|---|---|
| 価値 | パラメーターの値。 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
ポリシー定義を展開し、管理グループ に割り当てる Azure にデプロイする |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。 |
|
ポリシー Def を展開し、複数の Mgmt グループに割り当てる Azure にデプロイする |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
|
組み込みポリシーを既存のリソース グループ に割り当てる Azure にデプロイする |
このテンプレートは、組み込みのポリシーを既存のリソース グループに割り当てます。 |
|
VM マネージド ディスクを監査する組み込みポリシーを割り当 Azure にデプロイする |
このテンプレートでは、組み込みのポリシーをリソース グループ スコープに割り当てて、仮想マシン (VM) マネージド ディスクを監査します。 |
|
Azure Virtual Network Manager とサンプル VNET を作成する Azure にデプロイする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類をサポートします。 |
Terraform (AzAPI プロバイダー) リソース定義
policyAssignments リソースの種類は、拡張機能リソースです。つまり、別のリソースに適用できます。
このリソースの parent_id プロパティを使用して、このリソースのスコープを設定します。
policyAssignments リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの
- サブスクリプション
- 管理グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Authorization/policyAssignments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyAssignments@2021-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"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
}
})
}
プロパティ値
policyAssignments
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | "Microsoft.Authorization/policyAssignments@2021-06-01" |
| 名前 | リソース名 | string (必須) 文字制限: 1 ~ 128 表示名 1 から 64 リソース名 管理グループ スコープでの 1 から 24 個のリソース名 有効な文字: 表示名には任意の文字を含めることができます。 リソース名では、次の情報を使用できません。 <>*%&:\?.+/ または制御文字。 ピリオドまたはスペースで終えることはできません。 |
| 場所 | ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。 | 糸 |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| 同一性 | ポリシーの割り当てに関連付けられているマネージド ID。 | ID |
| プロパティ | ポリシー割り当てのプロパティ。 | PolicyAssignmentProperties の |
同一性
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | ID の種類。 これは、システム割り当て 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
| 名前 | 形容 | 価値 |
|---|---|---|
| 形容 | このメッセージは、ポリシー違反が発生した場合の応答の一部になります。 | 糸 |
| displayName | ポリシー割り当ての表示名。 | 糸 |
| enforcementMode | ポリシー割り当て適用モード。 使用できる値は Default と DoNotEnforce です。 | "Default" "DoNotEnforce" |
| metadata | ポリシー割り当てのメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。 | |
| nonComplianceMessages | リソースがポリシーに準拠していない理由を説明するメッセージ。 | NonComplianceMessage[] |
| notScopes | ポリシーの除外されたスコープ。 | string[] |
| パラメーター | 割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | 割り当てられているポリシー定義またはポリシー セット定義の ID。 | 糸 |
NonComplianceMessage
| 名前 | 形容 | 価値 |
|---|---|---|
| メッセージ | リソースがポリシーに準拠していない理由を説明するメッセージ。 これは、"拒否" エラー メッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。 | string (必須) |
| policyDefinitionReferenceId | メッセージの対象となるポリシー セット定義内のポリシー定義参照 ID。 これは、ポリシー割り当てによってポリシー セット定義が割り当てられている場合にのみ適用されます。 これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。 | 糸 |
ParameterValues
| 名前 | 形容 | 価値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 形容 | 価値 |
|---|---|---|
| 価値 | パラメーターの値。 |