Microsoft.Authorization policyDefinitions 2023-04-01
Bicep リソース定義
policyDefinitions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
policyDefinitions リソースの種類は、次を対象とする操作でデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
このリソースの種類は、 のレベルで読み取り専用リソースとして参照できます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyDefinitions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
プロパティ値
policyDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
| properties | ポリシー定義のプロパティ。 | PolicyDefinitionProperties |
PolicyDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー定義の説明。 | string |
| displayName | ポリシー定義の表示名。 | string |
| metadata | ポリシー定義メタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキー値ペアのコレクションです。 | Bicep の場合は、 any() 関数を使用できます。 |
| mode | ポリシー定義モード。 たとえば、All、Indexed、Microsoft.KeyVault.Data などです。 | string |
| parameters | ポリシー 規則で使用されるパラメーターのパラメーター定義。 キーはパラメーター名です。 | ParameterDefinitions |
| policyRule | ポリシールール。 | Bicep の場合は、 any() 関数を使用できます。 |
| policyType | ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。 | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| version | #.#.# 形式のポリシー定義バージョン。 | string |
| versions | このポリシー定義で使用できるバージョンの一覧。 | string[] |
ParameterDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| 名前 | 説明 | 値 |
|---|---|---|
| allowedValues | パラメーターに使用できる値。 | any[] |
| defaultValue | 値が指定されていない場合のパラメーターの既定値。 | Bicep の場合は、 any() 関数を使用できます。 |
| metadata | パラメーターの一般的なメタデータ。 | ParameterDefinitionsValueMetadata |
| schema | 自己定義 JSON スキーマを使用した割り当て中のパラメーター入力の検証を提供します。 このプロパティは、オブジェクト型パラメーターでのみサポートされ、Json.NET Schema 2019-09 の実装に従います。 スキーマの使用の詳細については、 で、 https://json-schema.org/ 下書きスキーマをテストする方法に関するページを参照してください。 https://www.jsonschemavalidator.net/. |
Bicep の場合は、 any() 関数を使用できます。 |
| 型 | パラメーターのデータ型です。 | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| assignPermissions | ポリシーの割り当て中に、このパラメーターのリソース ID またはリソース スコープ値に対してロールの割り当てを作成Azure portal場合は、true に設定します。 このプロパティは、割り当てスコープ外でアクセス許可を割り当てたい場合に便利です。 | [bool] |
| description | パラメーターの説明。 | string |
| displayName | パラメーターの表示名。 | string |
| strongType | ポータルを使用してポリシー定義を割り当てるときに使用されます。 ユーザーが選択できる値のコンテキスト対応リストを提供します。 | string |
| {カスタマイズされたプロパティ} | Bicep の場合は、 any() 関数を使用できます。 |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
ポリシー定義を展開し、管理グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。 |
| ポリシー Def を展開し、複数の Mgmt グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
| Azure Virtual Network Manager とサンプル VNET をCreateする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類がサポートされています。 |
ARM テンプレート リソース定義
policyDefinitions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを scope 設定するには、このリソースの プロパティを使用します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
policyDefinitions リソースの種類は、次を対象とする操作と共にデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
このリソースの種類は、次のレベルで読み取り専用リソースとして参照できます: テナント
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyDefinitions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
プロパティ値
policyDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Authorization/policyDefinitions' |
| apiVersion | リソース API のバージョン | '2023-04-01' |
| name | リソース名 | string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、 拡張 リソースを適用するリソースの完全な名前に値を設定します。 |
| properties | ポリシー定義のプロパティ。 | PolicyDefinitionProperties |
PolicyDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー定義の説明。 | string |
| displayName | ポリシー定義の表示名。 | string |
| metadata | ポリシー定義メタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
| mode | ポリシー定義モード。 たとえば、All、Indexed、Microsoft.KeyVault.Data などです。 | string |
| parameters | ポリシー ルールで使用されるパラメーターのパラメーター定義。 キーはパラメーター名です。 | ParameterDefinitions |
| policyRule | ポリシー ルール。 | |
| policyType | ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。 | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
| version | #.#.# 形式のポリシー定義のバージョン。 | string |
| versions | このポリシー定義で使用できるバージョンの一覧。 | string[] |
ParameterDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| 名前 | 説明 | 値 |
|---|---|---|
| allowedValues | パラメーターに使用できる値。 | any[] |
| defaultValue | 値が指定されていない場合のパラメーターの既定値。 | |
| metadata | パラメーターの一般的なメタデータ。 | ParameterDefinitionsValueMetadata |
| schema | 自己定義 JSON スキーマを使用した割り当て中のパラメーター入力の検証を提供します。 このプロパティは、オブジェクト型パラメーターでのみサポートされ、Json.NET Schema 2019-09 の実装に従います。 スキーマの使用の詳細については、 で、 https://json-schema.org/ 下書きスキーマをテストする方法に関するページを参照してください。 https://www.jsonschemavalidator.net/. |
|
| 型 | パラメーターのデータ型です。 | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| assignPermissions | ポリシーの割り当て中に、このパラメーターのリソース ID またはリソース スコープ値に対してロールの割り当てを作成Azure portal場合は、true に設定します。 このプロパティは、割り当てスコープ外でアクセス許可を割り当てたい場合に便利です。 | [bool] |
| description | パラメーターの説明。 | string |
| displayName | パラメーターの表示名。 | string |
| strongType | ポータルを使用してポリシー定義を割り当てるときに使用されます。 ユーザーが選択できる値のコンテキスト対応リストを提供します。 | string |
| {カスタマイズされたプロパティ} |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| ポリシー定義を展開し、管理グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループ レベルのテンプレートです。 現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。 |
| ポリシー Def を展開し、複数の Mgmt グループに割り当てる |
このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループ レベルのテンプレートです。 |
| Azure Virtual Network Manager とサンプル VNET をCreateする |
このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソース グループにデプロイします。 複数の接続トポロジとネットワーク グループ メンバーシップの種類がサポートされています。 |
Terraform (AzAPI プロバイダー) リソース定義
policyDefinitions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを parent_id 設定するには、このリソースの プロパティを使用します。
policyDefinitions リソースの種類は、次を対象とする操作と共にデプロイできます。
- 管理グループ
- サブスクリプション
このリソースの種類は、次のレベルで読み取り専用リソースとして参照できます: テナント
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policyDefinitions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
プロパティ値
policyDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Authorization/policyDefinitions@2023-04-01" |
| name | リソース名 | string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
| properties | ポリシー定義のプロパティ。 | PolicyDefinitionProperties |
PolicyDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー定義の説明。 | string |
| displayName | ポリシー定義の表示名。 | string |
| metadata | ポリシー定義メタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
| mode | ポリシー定義モード。 たとえば、All、Indexed、Microsoft.KeyVault.Data などです。 | string |
| parameters | ポリシー 規則で使用されるパラメーターのパラメーター定義。 キーはパラメーター名です。 | ParameterDefinitions |
| policyRule | ポリシールール。 | |
| policyType | ポリシー定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。 | "BuiltIn" "Custom" "NotSpecified" "Static" |
| version | #.#.# 形式のポリシー定義バージョン。 | string |
| versions | このポリシー定義で使用できるバージョンの一覧。 | string[] |
ParameterDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| 名前 | 説明 | 値 |
|---|---|---|
| allowedValues | パラメーターに使用できる値。 | any[] |
| defaultValue | 値が指定されていない場合のパラメーターの既定値。 | |
| metadata | パラメーターの一般的なメタデータ。 | ParameterDefinitionsValueMetadata |
| schema | 自己定義 JSON スキーマを使用した割り当て中のパラメーター入力の検証を提供します。 このプロパティは、オブジェクト型パラメーターでのみサポートされ、Json.NET Schema 2019-09 の実装に従います。 スキーマの使用の詳細については、下書きスキーマ https://json-schema.org/ のテストに関するページを参照してください。 https://www.jsonschemavalidator.net/. |
|
| 型 | パラメーターのデータ型です。 | "Array" "Boolean" "DateTime" "Float" "Integer" "Object" "String" |
ParameterDefinitionsValueMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| assignPermissions | ポリシーの割り当て中にこのパラメーターのリソース ID またはリソース スコープ値にロールの割り当てを作成Azure portal場合は true に設定します。 このプロパティは、割り当てスコープ外でアクセス許可を割り当てたい場合に便利です。 | [bool] |
| description | パラメーターの説明。 | string |
| displayName | パラメーターの表示名。 | string |
| strongType | ポータルを使用してポリシー定義を割り当てるときに使用されます。 ユーザーが選択する値のコンテキスト対応リストを提供します。 | string |
| {カスタマイズされたプロパティ} |