Microsoft.Authorization policySetDefinitions 2023-04-01
Bicep リソース定義
policySetDefinitions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
policySetDefinitions リソースの種類は、次を対象とする操作でデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
このリソースの種類は、 のレベルで読み取り専用リソースとして参照できます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policySetDefinitions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
プロパティ値
policySetDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
| properties | ポリシー セット定義のプロパティ。 | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー セット定義の説明。 | string |
| displayName | ポリシー セット定義の表示名。 | string |
| metadata | ポリシー セット定義メタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキー値ペアのコレクションです。 | Bicep の場合は、 any() 関数を使用できます。 |
| parameters | ポリシー定義参照で使用できるポリシー セット定義パラメーター。 | ParameterDefinitions |
| policyDefinitionGroups | ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 | PolicyDefinitionGroup[] |
| policyDefinitions | ポリシー定義参照の配列。 | PolicyDefinitionReference[] (必須) |
| 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() 関数を使用できます。 |
PolicyDefinitionGroup
| 名前 | 説明 | 値 |
|---|---|---|
| additionalMetadataId | グループに関する追加のメタデータを含むリソースのリソース ID。 | string |
| category | グループのカテゴリ。 | string |
| description | グループの説明。 | string |
| displayName | グループの表示名。 | string |
| name | グループの名前。 | string (必須) |
PolicyDefinitionReference
| 名前 | 説明 | 値 |
|---|---|---|
| groupNames | このポリシー定義が参照するグループの名前。 | string[] |
| parameters | 参照されるポリシー規則のパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | ポリシー定義またはポリシー セット定義の ID。 | string (必須) |
| policyDefinitionReferenceId | このポリシー定義リファレンスの一意の ID (ポリシー セット定義内)。 | string |
ParameterValues
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 説明 | 値 |
|---|---|---|
| value | パラメーターの値。 | Bicep の場合は、 any() 関数を使用できます。 |
ARM テンプレート リソース定義
policySetDefinitions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
policySetDefinitions リソースの種類は、次を対象とする操作でデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
このリソースの種類は、 のレベルで読み取り専用リソースとして参照できます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policySetDefinitions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
プロパティ値
policySetDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Authorization/policySetDefinitions' |
| apiVersion | リソース API のバージョン | '2023-04-01' |
| name | リソース名 | string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定 します 。 |
| properties | ポリシー セット定義のプロパティ。 | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー セット定義の説明。 | string |
| displayName | ポリシー セット定義の表示名。 | string |
| metadata | ポリシー セット定義メタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
| parameters | ポリシー定義参照で使用できるポリシー セット定義パラメーター。 | ParameterDefinitions |
| policyDefinitionGroups | ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 | PolicyDefinitionGroup[] |
| policyDefinitions | ポリシー定義参照の配列。 | PolicyDefinitionReference[] (必須) |
| 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 |
| {カスタマイズされたプロパティ} |
PolicyDefinitionGroup
| 名前 | 説明 | 値 |
|---|---|---|
| additionalMetadataId | グループに関する追加のメタデータを含むリソースのリソース ID。 | string |
| category | グループのカテゴリ。 | string |
| description | グループの説明。 | string |
| displayName | グループの表示名。 | string |
| name | グループの名前。 | string (必須) |
PolicyDefinitionReference
| 名前 | 説明 | 値 |
|---|---|---|
| groupNames | このポリシー定義が参照するグループの名前。 | string[] |
| parameters | 参照されるポリシー 規則のパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | ポリシー定義またはポリシー セット定義の ID。 | string (必須) |
| policyDefinitionReferenceId | このポリシー定義リファレンスの (ポリシー セット定義内の) 一意の ID。 | string |
ParameterValues
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 説明 | 値 |
|---|---|---|
| value | パラメーターの値。 |
Terraform (AzAPI プロバイダー) リソース定義
policySetDefinitions リソースの種類は 拡張機能リソースです。つまり、別のリソースに適用できます。
このリソースの スコープを parent_id 設定するには、このリソースの プロパティを使用します。
policySetDefinitions リソースの種類は、次を対象とする操作と共にデプロイできます。
- 管理グループ
- サブスクリプション
このリソースの種類は、次のレベルで読み取り専用リソースとして参照できます: テナント
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Authorization/policySetDefinitions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
groupNames = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
プロパティ値
policySetDefinitions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Authorization/policySetDefinitions@2023-04-01" |
| name | リソース名 | string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 有効な文字: 表示名には任意の文字を含めることができます。 次のリソース名は使用できません: 末尾をピリオドまたはスペースにすることはできません。 |
| parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
| properties | ポリシー セット定義のプロパティ。 | PolicySetDefinitionProperties |
PolicySetDefinitionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| description | ポリシー セット定義の説明。 | string |
| displayName | ポリシー セット定義の表示名。 | string |
| metadata | ポリシー セット定義メタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。 | |
| parameters | ポリシー定義参照で使用できるポリシー セット定義パラメーター。 | ParameterDefinitions |
| policyDefinitionGroups | ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 | PolicyDefinitionGroup[] |
| policyDefinitions | ポリシー定義参照の配列。 | PolicyDefinitionReference[] (必須) |
| 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 |
| {カスタマイズされたプロパティ} |
PolicyDefinitionGroup
| 名前 | 説明 | 値 |
|---|---|---|
| additionalMetadataId | グループに関する追加のメタデータを含むリソースのリソース ID。 | string |
| category | グループのカテゴリ。 | string |
| description | グループの説明。 | string |
| displayName | グループの表示名。 | string |
| name | グループの名前。 | string (必須) |
PolicyDefinitionReference
| 名前 | 説明 | 値 |
|---|---|---|
| groupNames | このポリシー定義が参照するグループの名前。 | string[] |
| parameters | 参照されるポリシー規則のパラメーター値。 キーはパラメーター名です。 | ParameterValues |
| policyDefinitionId | ポリシー定義またはポリシー セット定義の ID。 | string (必須) |
| policyDefinitionReferenceId | このポリシー定義リファレンスの一意の ID (ポリシー セット定義内)。 | string |
ParameterValues
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | ParameterValuesValue |
ParameterValuesValue
| 名前 | 説明 | 値 |
|---|---|---|
| value | パラメーターの値。 |