Microsoft.Authorization policySetDefinitions

• 最新
• 2021-06-01
• 2020-09-01

Bicep 資源定義

policySetDefinitions 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 Bicep 中設定擴充功能資源的範圍。

policySetDefinitions 資源的有效部署範圍如下：

• 管理群組 - 請參閱 管理群組部署命令
• 訂 用帳戶 - 請參閱 訂用帳戶部署命令

您可以在下列層級將此資源類型參考為唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {}
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {}
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

屬性值

policySetDefinitions

名稱	描述	值
NAME	資源名稱	需要字串 () 字元限制：1-128 顯示名稱 1-64 (資源名稱) 有效字元： 顯示名稱可包含任何字元。 資源名稱不能使用： <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。
scope	在與部署範圍不同的範圍內建立擴充資源時，請使用 。	目標資源 針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。
properties	原則定義屬性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名稱	描述	值
description	原則集定義描述。	字串
displayName	原則集定義的顯示名稱。	字串
中繼資料	原則集定義中繼資料。 中繼資料是開放式物件，通常是索引鍵值組的集合。	針對 Bicep，您可以使用 any () 函式。
parameters	原則集定義參數，可用於原則定義參考。	object
policyDefinitionGroups	中繼資料，描述原則集定義內的原則定義參考群組。	PolicyDefinitionGroup[]
policyDefinitions	原則定義參考的陣列。	PolicyDefinitionReference[] (必要)
policyType	原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。	'BuiltIn' 'Custom' 'NotSpecified' 'Static'

PolicyDefinitionGroup

名稱	描述	值
additionalMetadataId	資源的資源識別碼，其中包含群組的其他中繼資料。	字串
category	群組的類別。	字串
description	群組的描述。	字串
displayName	群組的顯示名稱。	字串
NAME	群組的名稱。	需要字串 ()

PolicyDefinitionReference

名稱	描述	值
groupNames	此原則定義參考所屬的組名。	string[]
parameters	參考之原則規則的參數值。 索引鍵是參數名稱。	object
policyDefinitionId	原則定義或原則集定義的識別碼。	字串 (必要)
policyDefinitionReferenceId	此原則定義參考的原則集定義) 內的唯一識別碼 (。	字串

ARM 範本資源定義

policySetDefinitions 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 ARM 範本中設定擴充功能資源的範圍。

policySetDefinitions 資源的有效部署範圍如下：

• 管理群組 - 請參閱 管理群組部署命令
• 訂 用帳戶 - 請參閱 訂用帳戶部署命令

您可以將此資源類型參考為層級的唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {},
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {},
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string"
  }
}

屬性值

policySetDefinitions

名稱	描述	值
type	資源類型	'Microsoft.Authorization/policySetDefinitions'
apiVersion	資源 API 版本	'2021-06-01'
NAME	資源名稱	字串 (必要) 字元限制：1-128 顯示名稱 1-64 (資源名稱) 有效字元： 顯示名稱可包含任何字元。 資源名稱不能使用： <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。
scope	在與部署範圍不同的範圍建立擴充資源時，請使用 。	目標資源 針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。
properties	原則定義屬性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名稱	描述	值
description	原則集定義描述。	字串
displayName	原則集定義的顯示名稱。	字串
中繼資料	原則集定義中繼資料。 中繼資料是開放式物件，通常是索引鍵值組的集合。
parameters	可用於原則定義參考的原則集定義參數。	object
policyDefinitionGroups	描述原則集定義內原則定義參考群組的中繼資料。	PolicyDefinitionGroup[]
policyDefinitions	原則定義參考的陣列。	PolicyDefinitionReference[] (必要)
policyType	原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。	'BuiltIn' 'Custom' 'NotSpecified' 'Static'

PolicyDefinitionGroup

名稱	描述	值
additionalMetadataId	資源的資源識別碼，其中包含有關群組的其他中繼資料。	字串
category	群組的類別。	字串
description	群組的描述。	字串
displayName	群組的顯示名稱。	字串
NAME	群組的名稱。	字串 (必要)

PolicyDefinitionReference

名稱	描述	值
groupNames	此原則定義參考所屬的群組名稱。	string[]
parameters	參考之原則規則的參數值。 索引鍵是參數名稱。	object
policyDefinitionId	原則定義或原則集定義的識別碼。	需要字串 ()
policyDefinitionReferenceId	此原則定義參考的原則集定義) 內的唯一識別碼 (。	字串

Terraform (AzAPI 提供者) 資源定義

policySetDefinitions 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

parent_id使用此資源上的 屬性來設定此資源的範圍。

policySetDefinitions 資源的有效部署範圍如下：

• 管理群組
• 訂用帳戶

您可以在下列層級將此資源類型參考為唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Authorization/policySetDefinitions 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {}
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {}
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
    }
  })
}

屬性值

policySetDefinitions

名稱	描述	值
type	資源類型	「Microsoft.Authorization/policySetDefinitions@2021-06-01」
NAME	資源名稱	需要字串 () 字元限制：1-128 顯示名稱 1-64 (資源名稱) 有效字元： 顯示名稱可包含任何字元。 資源名稱不能使用： <>*%&:\?.+/ 或控制字元。 不能以句號或空格結尾。
parent_id	要套用此擴充功能資源的資源識別碼。	需要字串 ()
properties	原則定義屬性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名稱	描述	值
description	原則集定義描述。	字串
displayName	原則集定義的顯示名稱。	字串
中繼資料	原則集定義中繼資料。 中繼資料是開放式物件，通常是索引鍵值組的集合。
parameters	原則集定義參數，可用於原則定義參考。	object
policyDefinitionGroups	中繼資料，描述原則集定義內的原則定義參考群組。	PolicyDefinitionGroup[]
policyDefinitions	原則定義參考的陣列。	PolicyDefinitionReference[] (必要)
policyType	原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。	「BuiltIn」 「自訂」 「NotSpecified」 「Static」

PolicyDefinitionGroup

名稱	描述	值
additionalMetadataId	資源的資源識別碼，其中包含群組的其他中繼資料。	字串
category	群組的類別。	字串
description	群組的描述。	字串
displayName	群組的顯示名稱。	字串
NAME	群組的名稱。	需要字串 ()

PolicyDefinitionReference

名稱	描述	值
groupNames	此原則定義參考所屬的組名。	string[]
parameters	參考之原則規則的參數值。 索引鍵是參數名稱。	object
policyDefinitionId	原則定義或原則集定義的識別碼。	字串 (必要)
policyDefinitionReferenceId	此原則定義參考的原則集定義) 內的唯一識別碼 (。	字串