Microsoft.Authorization policyDefinitions

  • 發行項

Bicep 資源定義

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

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

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

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

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

資源格式

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

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    mode: 'string'
    parameters: {}
    policyRule: any()
    policyType: 'string'
  }
}

屬性值

policyDefinitions

名稱 描述 值
NAME 資源名稱 需要字串 ()

字元限制：1-128 顯示名稱

1-64 (資源名稱)

合法字元：
顯示名稱可包含任何字元。

資源名稱不能使用：
<>*%&:\?.+/ 或控制字元。

不能以句號或空格結尾。
範圍 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 目標資源

針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。
properties 原則定義屬性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名稱 描述 值
description 原則定義描述。 字串
displayName 原則定義的顯示名稱。 字串
中繼資料 原則定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。 針對 Bicep，您可以使用 any () 函式。
mode 原則定義模式。 一些範例包括 All、Indexed、Microsoft.KeyVault.Data。 字串
參數 原則規則中使用的參數參數定義。 索引鍵是參數名稱。 物件 (object)
policyRule 原則規則。 針對 Bicep，您可以使用 any () 函式。
policyType 原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 'BuiltIn'
'Custom'
'NotSpecified'
'Static'

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
部署原則定義並指派給管理群組

部署至 Azure		 此範本是管理群組層級範本，會建立原則定義，並將該原則指派給目標管理群組。 目前無法透過 Azure 入口網站部署此範本。
部署原則Def並指派給多個 Mgmt 群組

部署至 Azure		 此範本是管理群組層級範本，會建立原則定義，並將該原則指派給多個管理群組。
建立 Azure 虛擬網路 管理員和範例 VNET

部署至 Azure		 此範本會將 Azure 虛擬網路 Manager 和範例虛擬網路部署到具名資源群組中。 它支援多個連線拓撲和網路群組成員資格類型。

ARM 範本資源定義

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

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

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

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

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

資源格式

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

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {},
    "policyRule": {},
    "policyType": "string"
  }
}

屬性值

policyDefinitions

名稱 描述 值
類型 資源類型 'Microsoft.Authorization/policyDefinitions'
apiVersion 資源 API 版本 '2021-06-01'
NAME 資源名稱 字串 (必要)

字元限制：1-128 顯示名稱

1-64 (資源名稱)

合法字元：
顯示名稱可包含任何字元。

資源名稱不能使用：
<>*%&:\?.+/ 或控制字元。

不能以句號或空格結尾。
範圍 在與部署範圍不同的範圍建立擴充資源時，請使用 。 目標資源

針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。
properties 原則定義屬性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名稱 描述 值
description 原則定義描述。 字串
displayName 原則定義的顯示名稱。 字串
中繼資料 原則定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。
mode 原則定義模式。 一些範例包括 All、Indexed、Microsoft.KeyVault.Data。 字串
參數 原則規則中使用的參數定義。 索引鍵是參數名稱。 物件 (object)
policyRule 原則規則。
policyType 原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 'BuiltIn'
'Custom'
'NotSpecified'
'Static'

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
部署原則定義並指派給管理群組

部署至 Azure		 此範本是管理群組層級範本，將會建立原則定義，並將該原則指派給目標管理群組。 目前無法透過 Azure 入口網站部署此範本。
部署原則Def並指派給多個 Mgmt 群組

部署至 Azure		 此範本是管理群組層級範本，將建立原則定義，並將該原則指派給多個管理群組。
建立 Azure 虛擬網路 管理員和範例 VNET

部署至 Azure		 此範本會將 Azure 虛擬網路 管理員和範例虛擬網路部署到具名資源群組。 它支援多個連線拓撲和網路群組成員資格類型。

Terraform (AzAPI 提供者) 資源定義

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

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

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

  • 管理群組
  • 訂用帳戶

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

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      mode = "string"
      parameters = {}
      policyType = "string"
    }
  })
}

屬性值

policyDefinitions

名稱 描述 值
類型 資源類型 “Microsoft.Authorization/policyDefinitions@2021-06-01”
NAME 資源名稱 字串 (必要)

字元限制：1-128 顯示名稱

1-64 (資源名稱)

合法字元：
顯示名稱可包含任何字元。

資源名稱不能使用：
<>*%&:\?.+/ 或控制字元。

不能以句號或空格結尾。
parent_id 要套用此擴充功能資源的資源標識碼。 需要字串 ()
properties 原則定義屬性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名稱 描述 值
description 原則定義描述。 字串
displayName 原則定義的顯示名稱。 字串
中繼資料 原則定義元數據。 元數據是開放式物件，通常是索引鍵值組的集合。
mode 原則定義模式。 一些範例包括 All、Indexed、Microsoft.KeyVault.Data。 字串
參數 原則規則中使用的參數參數定義。 索引鍵是參數名稱。 物件 (object)
policyRule 原則規則。
policyType 原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 “BuiltIn”
"Custom"
“NotSpecified”
“Static”