Microsoft.Authorization policySetDefinitions 2023-04-01
Bicep 資源定義
policySetDefinitions 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
parameters: {
{customized property}: {
allowedValues: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
definitionVersion: 'string'
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
屬性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必要） |
| 性能 | 原則集定義屬性。 | PolicySetDefinitionProperties |
ParameterDefinitions
| 名字 | 描述 | 價值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 參數的允許值。 | any[] |
| defaultValue | 如果未提供任何值，則為 參數的預設值。 | 任何 |
| 元數據 | 參數的一般元數據。 | ParameterDefinitionsValueMetadata |
| 圖式 | 使用自我定義 JSON 架構，在指派期間提供參數輸入的驗證。 此屬性僅支持物件類型參數，並遵循架構 2019-09 實作 Json.NET。 您可以在 https://json-schema.org/ 深入瞭解如何使用架構，並在 https://www.jsonschemavalidator.net/測試草稿架構。 | 任何 |
| 類型 | 參數的數據類型。 | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| assignPermissions | 設定為 true，讓 Azure 入口網站在原則指派期間，於此參數的資源標識碼或資源範圍值上建立角色指派。 如果您想要在指派範圍之外指派許可權，這個屬性就很有用。 | bool |
| 描述 | 參數的描述。 | 字串 |
| displayName | 參數的顯示名稱。 | 字串 |
| strongType | 透過入口網站指派原則定義時使用。 提供內容感知值清單，供用戶選擇。 | 字串 |
ParameterValues
| 名字 | 描述 | 價值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | 參數的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalMetadataId | 資源的資源標識碼，其中包含群組的其他元數據。 | 字串 |
| 類別 | 群組的類別。 | 字串 |
| 描述 | 群組的描述。 | 字串 |
| displayName | 群組的顯示名稱。 | 字串 |
| 名字 | 群組的名稱。 | 字串 （必要） |
PolicyDefinitionReference
| 名字 | 描述 | 價值 |
|---|---|---|
| definitionVersion | 要使用的原則定義版本。 | 字串 |
| groupNames | 此原則定義參考所屬的組名。 | string[] |
| 參數 | 參考原則規則的參數值。 索引鍵是參數名稱。 | ParameterValues |
| policyDefinitionId | 原則定義或原則集定義的標識碼。 | 字串 （必要） |
| policyDefinitionReferenceId | 此原則定義參考的唯一標識碼（在原則集定義內）。 | 字串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 原則集定義描述。 | 字串 |
| displayName | 原則集定義的顯示名稱。 | 字串 |
| 元數據 | 原則集定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。 | 任何 |
| 參數 | 原則集定義參數，可用於原則定義參考。 | ParameterDefinitions |
| policyDefinitionGroups | 元數據，描述原則集定義內的原則定義參考群組。 | PolicyDefinitionGroup[] |
| policyDefinitions | 原則定義參考的陣列。 | PolicyDefinitionReference[] （必要） |
| policyType | 原則集定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| 版本 | 原則會以 #.#.# 格式設定定義版本。 | 字串 |
| 版本 | 此原則集定義的可用版本清單。 | string[] |
ARM 樣本資源定義
policySetDefinitions 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string"
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"definitionVersion": "string",
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
屬性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2023-04-01' |
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必要） |
| 性能 | 原則集定義屬性。 | PolicySetDefinitionProperties |
| 類型 | 資源類型 | 'Microsoft.Authorization/policySetDefinitions' |
ParameterDefinitions
| 名字 | 描述 | 價值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 參數的允許值。 | any[] |
| defaultValue | 如果未提供任何值，則為 參數的預設值。 | 任何 |
| 元數據 | 參數的一般元數據。 | ParameterDefinitionsValueMetadata |
| 圖式 | 使用自我定義 JSON 架構，在指派期間提供參數輸入的驗證。 此屬性僅支持物件類型參數，並遵循架構 2019-09 實作 Json.NET。 您可以在 https://json-schema.org/ 深入瞭解如何使用架構，並在 https://www.jsonschemavalidator.net/測試草稿架構。 | 任何 |
| 類型 | 參數的數據類型。 | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| assignPermissions | 設定為 true，讓 Azure 入口網站在原則指派期間，於此參數的資源標識碼或資源範圍值上建立角色指派。 如果您想要在指派範圍之外指派許可權，這個屬性就很有用。 | bool |
| 描述 | 參數的描述。 | 字串 |
| displayName | 參數的顯示名稱。 | 字串 |
| strongType | 透過入口網站指派原則定義時使用。 提供內容感知值清單，供用戶選擇。 | 字串 |
ParameterValues
| 名字 | 描述 | 價值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | 參數的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalMetadataId | 資源的資源標識碼，其中包含群組的其他元數據。 | 字串 |
| 類別 | 群組的類別。 | 字串 |
| 描述 | 群組的描述。 | 字串 |
| displayName | 群組的顯示名稱。 | 字串 |
| 名字 | 群組的名稱。 | 字串 （必要） |
PolicyDefinitionReference
| 名字 | 描述 | 價值 |
|---|---|---|
| definitionVersion | 要使用的原則定義版本。 | 字串 |
| groupNames | 此原則定義參考所屬的組名。 | string[] |
| 參數 | 參考原則規則的參數值。 索引鍵是參數名稱。 | ParameterValues |
| policyDefinitionId | 原則定義或原則集定義的標識碼。 | 字串 （必要） |
| policyDefinitionReferenceId | 此原則定義參考的唯一標識碼（在原則集定義內）。 | 字串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 原則集定義描述。 | 字串 |
| displayName | 原則集定義的顯示名稱。 | 字串 |
| 元數據 | 原則集定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。 | 任何 |
| 參數 | 原則集定義參數，可用於原則定義參考。 | ParameterDefinitions |
| policyDefinitionGroups | 元數據，描述原則集定義內的原則定義參考群組。 | PolicyDefinitionGroup[] |
| policyDefinitions | 原則定義參考的陣列。 | PolicyDefinitionReference[] （必要） |
| policyType | 原則集定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| 版本 | 原則會以 #.#.# 格式設定定義版本。 | 字串 |
| 版本 | 此原則集定義的可用版本清單。 | string[] |
Terraform （AzAPI 提供者） 資源定義
policySetDefinitions 資源類型可以使用目標作業來部署：
- 租使用者* 管理群組* 訂用帳戶
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2023-04-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
metadata = ?
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
schema = ?
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
definitionVersion = "string"
groupNames = [
"string"
]
parameters = {
{customized property} = {
value = ?
}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
屬性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必要） |
| 性能 | 原則集定義屬性。 | PolicySetDefinitionProperties |
| 類型 | 資源類型 | “Microsoft.Authorization/policySetDefinitions@2023-04-01” |
ParameterDefinitions
| 名字 | 描述 | 價值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 參數的允許值。 | any[] |
| defaultValue | 如果未提供任何值，則為 參數的預設值。 | 任何 |
| 元數據 | 參數的一般元數據。 | ParameterDefinitionsValueMetadata |
| 圖式 | 使用自我定義 JSON 架構，在指派期間提供參數輸入的驗證。 此屬性僅支持物件類型參數，並遵循架構 2019-09 實作 Json.NET。 您可以在 https://json-schema.org/ 深入瞭解如何使用架構，並在 https://www.jsonschemavalidator.net/測試草稿架構。 | 任何 |
| 類型 | 參數的數據類型。 | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| assignPermissions | 設定為 true，讓 Azure 入口網站在原則指派期間，於此參數的資源標識碼或資源範圍值上建立角色指派。 如果您想要在指派範圍之外指派許可權，這個屬性就很有用。 | bool |
| 描述 | 參數的描述。 | 字串 |
| displayName | 參數的顯示名稱。 | 字串 |
| strongType | 透過入口網站指派原則定義時使用。 提供內容感知值清單，供用戶選擇。 | 字串 |
ParameterValues
| 名字 | 描述 | 價值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | 參數的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalMetadataId | 資源的資源標識碼，其中包含群組的其他元數據。 | 字串 |
| 類別 | 群組的類別。 | 字串 |
| 描述 | 群組的描述。 | 字串 |
| displayName | 群組的顯示名稱。 | 字串 |
| 名字 | 群組的名稱。 | 字串 （必要） |
PolicyDefinitionReference
| 名字 | 描述 | 價值 |
|---|---|---|
| definitionVersion | 要使用的原則定義版本。 | 字串 |
| groupNames | 此原則定義參考所屬的組名。 | string[] |
| 參數 | 參考原則規則的參數值。 索引鍵是參數名稱。 | ParameterValues |
| policyDefinitionId | 原則定義或原則集定義的標識碼。 | 字串 （必要） |
| policyDefinitionReferenceId | 此原則定義參考的唯一標識碼（在原則集定義內）。 | 字串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 原則集定義描述。 | 字串 |
| displayName | 原則集定義的顯示名稱。 | 字串 |
| 元數據 | 原則集定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。 | 任何 |
| 參數 | 原則集定義參數，可用於原則定義參考。 | ParameterDefinitions |
| policyDefinitionGroups | 元數據，描述原則集定義內的原則定義參考群組。 | PolicyDefinitionGroup[] |
| policyDefinitions | 原則定義參考的陣列。 | PolicyDefinitionReference[] （必要） |
| policyType | 原則集定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| 版本 | 原則會以 #.#.# 格式設定定義版本。 | 字串 |
| 版本 | 此原則集定義的可用版本清單。 | string[] |