Microsoft.Authorization policyAssignments 2021-06-01
Bicep 資源定義
policyAssignments 資源類型是 延伸模組資源,這表示您可以將它套用至另一個資源。
scope
使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 Bicep 中設定擴充功能資源的範圍。
原則指派資源的有效部署範圍如下:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Authorization/policyAssignments 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Authorization/policyAssignments@2021-06-01' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
description: 'string'
displayName: 'string'
enforcementMode: 'string'
metadata: any()
nonComplianceMessages: [
{
message: 'string'
policyDefinitionReferenceId: 'string'
}
]
notScopes: [
'string'
]
parameters: {}
policyDefinitionId: 'string'
}
}
屬性值
policyAssignments
名稱 | 描述 | 值 |
---|---|---|
NAME | 資源名稱 | 需要字串 () 字元限制:1-128 顯示名稱 1-64 (資源名稱) 1-24 (管理群組範圍的資源名稱) 合法字元: 顯示名稱可包含任何字元。 資源名稱不能使用: <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。 |
location | 原則指派的位置。 只有在使用受控識別時才需要。 | 字串 |
範圍 | 在與部署範圍不同的範圍內建立擴充資源時,請使用 。 | 目標資源 針對 Bicep,請將此屬性設定為資源的符號名稱,以套用 延伸模組資源。 |
身分識別 | 與原則指派相關聯的受控識別。 | 身分識別 |
properties | 原則指派的屬性。 | PolicyAssignmentProperties |
Identity
名称 | 描述 | 值 |
---|---|---|
類型 | 識別類型。 這是將系統或使用者指派的身分識別新增至資源時的唯一必要字段。 | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | 與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 物件 (object) |
PolicyAssignmentProperties
名稱 | 描述 | 值 |
---|---|---|
description | 發生原則違規時,此訊息會是回應的一部分。 | 字串 |
displayName | 原則指派的顯示名稱。 | 字串 |
enforcementMode | 原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。 | 'Default' 'DoNotEnforce' |
中繼資料 | 原則指派元數據。 元數據是開放式物件,通常是索引鍵值組的集合。 | 針對 Bicep,您可以使用 any () 函式。 |
nonComplianceMessages | 描述為何資源不符合原則規範的訊息。 | NonComplianceMessage[] |
notScopes | 原則的排除範圍。 | string[] |
參數 | 指派之原則規則的參數值。 索引鍵是參數名稱。 | 物件 (object) |
policyDefinitionId | 要指派的原則定義或原則集定義的標識碼。 | 字串 |
NonComplianceMessage
名稱 | 描述 | 值 |
---|---|---|
message | 描述資源不符合原則規範原因的訊息。 這會顯示在「拒絕」錯誤訊息中,以及資源不符合規範的合規性結果。 | 字串 (必要) |
policyDefinitionReferenceId | 訊息要用於的原則集定義內的原則定義參考標識碼。 只有在原則指派指派原則集定義時,才適用。 如果未提供此訊息,訊息會套用至此原則指派所指派的所有原則。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
部署原則定義並指派給管理群組 |
此範本是管理群組層級範本,將會建立原則定義,並將該原則指派給目標管理群組。 目前無法透過 Azure 入口網站部署此範本。 |
部署原則Def並指派給多個 Mgmt 群組 |
此範本是管理群組層級範本,將建立原則定義,並將該原則指派給多個管理群組。 |
將內建原則指派給現有的資源群組 |
此範本會將內建原則指派給現有的資源群組。 |
建立 Azure 虛擬網路 管理員和範例 VNET |
此範本會將 Azure 虛擬網路 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": {}
},
"properties": {
"description": "string",
"displayName": "string",
"enforcementMode": "string",
"metadata": {},
"nonComplianceMessages": [
{
"message": "string",
"policyDefinitionReferenceId": "string"
}
],
"notScopes": [ "string" ],
"parameters": {},
"policyDefinitionId": "string"
}
}
屬性值
policyAssignments
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | 'Microsoft.Authorization/policyAssignments' |
apiVersion | 資源 API 版本 | '2021-06-01' |
NAME | 資源名稱 | 字串 (必要) 字元限制:1-128 顯示名稱 1-64 (資源名稱) 1-24 (管理群組範圍的資源名稱) 合法字元: 顯示名稱可包含任何字元。 資源名稱不能使用: <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。 |
location | 原則指派的位置。 只有在使用受控識別時才需要。 | 字串 |
範圍 | 在與部署範圍不同的範圍建立擴充資源時,請使用 。 | 目標資源 針對 JSON,請將值設定為要套用 擴充資源 的資源完整名稱。 |
身分識別 | 與原則指派相關聯的受控識別。 | 身分識別 |
properties | 原則指派的屬性。 | PolicyAssignmentProperties |
Identity
名称 | 描述 | 值 |
---|---|---|
類型 | 識別類型。 將系統或使用者指派的身分識別新增至資源時,這是唯一的必要字段。 | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | 與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 物件 (object) |
PolicyAssignmentProperties
名稱 | 描述 | 值 |
---|---|---|
description | 如果違反原則,此訊息將會是回應的一部分。 | 字串 |
displayName | 原則指派的顯示名稱。 | 字串 |
enforcementMode | 原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。 | 'Default' 'DoNotEnforce' |
中繼資料 | 原則指派元數據。 元數據是開放式物件,通常是索引鍵值組的集合。 | |
nonComplianceMessages | 描述資源不符合原則規範原因的訊息。 | NonComplianceMessage[] |
notScopes | 原則的排除範圍。 | string[] |
參數 | 指派之原則規則的參數值。 索引鍵是參數名稱。 | 物件 (object) |
policyDefinitionId | 要指派的原則定義或原則集定義的標識碼。 | 字串 |
NonComplianceMessage
名稱 | 描述 | 值 |
---|---|---|
message | 描述資源不符合原則規範原因的訊息。 這會顯示在「拒絕」錯誤訊息中,以及資源不符合規範的合規性結果。 | 字串 (必要) |
policyDefinitionReferenceId | 訊息要用於的原則集定義內的原則定義參考標識碼。 只有在原則指派指派原則集定義時,才適用。 如果未提供此訊息,訊息會套用至此原則指派所指派的所有原則。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
部署原則定義並指派給管理群組 |
此範本是管理群組層級範本,將會建立原則定義,並將該原則指派給目標管理群組。 目前無法透過 Azure 入口網站部署此範本。 |
部署原則Def並指派給多個 Mgmt 群組 |
此範本是管理群組層級範本,將建立原則定義,並將該原則指派給多個管理群組。 |
將內建原則指派給現有的資源群組 |
此範本會將內建原則指派給現有的資源群組。 |
建立 Azure 虛擬網路 管理員和範例 VNET |
此範本會將 Azure 虛擬網路 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 = {}
policyDefinitionId = "string"
}
})
}
屬性值
policyAssignments
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | “Microsoft.Authorization/policyAssignments@2021-06-01” |
NAME | 資源名稱 | 字串 (必要) 字元限制:1-128 顯示名稱 1-64 (資源名稱) 1-24 (管理群組範圍的資源名稱) 合法字元: 顯示名稱可包含任何字元。 資源名稱不能使用: <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。 |
location | 原則指派的位置。 只有在使用受控識別時才需要。 | 字串 |
parent_id | 要套用此延伸模組資源的資源標識碼。 | 字串 (必要) |
身分識別 | 與原則指派相關聯的受控識別。 | 身分識別 |
properties | 原則指派的屬性。 | PolicyAssignmentProperties |
Identity
名称 | 描述 | 值 |
---|---|---|
類型 | 識別類型。 將系統或使用者指派的身分識別新增至資源時,這是唯一的必要字段。 | “SystemAssigned” “UserAssigned” |
identity_ids | 與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 使用者身分識別標識碼的陣列。 |
PolicyAssignmentProperties
名稱 | 描述 | 值 |
---|---|---|
description | 如果違反原則,此訊息將會是回應的一部分。 | 字串 |
displayName | 原則指派的顯示名稱。 | 字串 |
enforcementMode | 原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。 | “Default” “DoNotEnforce” |
中繼資料 | 原則指派元數據。 元數據是開放式物件,通常是索引鍵值組的集合。 | |
nonComplianceMessages | 描述資源不符合原則規範原因的訊息。 | NonComplianceMessage[] |
notScopes | 原則的排除範圍。 | string[] |
參數 | 指派之原則規則的參數值。 索引鍵是參數名稱。 | 物件 (object) |
policyDefinitionId | 要指派的原則定義或原則集定義的標識碼。 | 字串 |
NonComplianceMessage
名稱 | 描述 | 值 |
---|---|---|
message | 描述資源不符合原則規範原因的訊息。 這會顯示在「拒絕」錯誤訊息中,以及資源不符合規範的合規性結果。 | 字串 (必要) |
policyDefinitionReferenceId | 訊息要用於的原則集定義內的原則定義參考標識碼。 只有在原則指派指派原則集定義時,才適用。 如果未提供此訊息,訊息會套用至此原則指派所指派的所有原則。 | 字串 |