Policy Set Definitions - List By Management Group
管理グループ内のすべてのポリシー セット定義を取得します。
この操作により、指定された管理グループ内のすべてのポリシー セット定義の一覧が取得され、オプションの指定された$filterに一致します。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、直接適用されるものや、特定の管理グループを含む管理グループから適用されるものも含め、管理グループに関連付けられているすべてのポリシー セット定義が含まれます。 $filter=atExactScope() が指定されている場合、返されるリストには、指定された管理グループにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
management
|
path | True |
string |
管理グループの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
$filter
|
query |
string |
操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。 |
|
$top
|
query |
integer int32 |
返されるレコードの最大数。 $top フィルターが指定されていない場合、500 レコードが返されます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK - ポリシー セット定義の配列を返します。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
List policy set definitions at management group level
Sample Request
Sample Response
{
"value": [
{
"properties": {
"displayName": "[Preview]: Enable Monitoring in Azure Security Center",
"policyType": "BuiltIn",
"description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.",
"metadata": {
"category": "Security Center"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"parameters": {},
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16",
"policyDefinitionReferenceId": "RefId1"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
"policyDefinitionReferenceId": "RefId2"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
"policyDefinitionReferenceId": "RefId3"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
"policyDefinitionReferenceId": "RefId4"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
"policyDefinitionReferenceId": "RefId5"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
"policyDefinitionReferenceId": "RefId6"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
"policyDefinitionReferenceId": "RefId7"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
"policyDefinitionReferenceId": "RefId8"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
"policyDefinitionReferenceId": "RefId9"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
"policyDefinitionReferenceId": "RefId10"
}
]
},
"id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
"type": "Microsoft.Authorization/policySetDefinitions",
"name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
},
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
"type": "Microsoft.Authorization/policySetDefinitions",
"name": "CostManagement",
"properties": {
"displayName": "Cost Management",
"description": "Policies to enforce low cost storage SKUs",
"metadata": {
"category": "Cost Management"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
]
}
定義
名前 | 説明 |
---|---|
Cloud |
ポリシー操作からのエラー応答。 |
created |
リソースを作成した ID の種類。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラー応答 |
Metadata |
パラメーターの一般的なメタデータ。 |
Parameter |
ポリシーに指定できるパラメーターの定義。 |
parameter |
パラメーターのデータ型です。 |
Parameter |
パラメーターの値。 |
Policy |
ポリシー定義グループ。 |
Policy |
ポリシー定義のリファレンス。 |
Policy |
ポリシー セットの定義。 |
Policy |
ポリシー セット定義の一覧。 |
policy |
ポリシー セット定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
CloudError
ポリシー操作からのエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー応答 |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
Metadata
パラメーターの一般的なメタデータ。
名前 | 型 | 説明 |
---|---|---|
assignPermissions |
boolean |
ポリシーの割り当て中に、このパラメーターのリソース ID またはリソース スコープ値に対してロールの割り当てを作成Azure portal場合は、true に設定します。 このプロパティは、割り当てスコープ外でアクセス許可を割り当てたい場合に便利です。 |
description |
string |
パラメーターの説明。 |
displayName |
string |
パラメーターの表示名。 |
strongType |
string |
ポータルを使用してポリシー定義を割り当てるときに使用されます。 ユーザーが選択できる値のコンテキスト対応リストを提供します。 |
ParameterDefinitionsValue
ポリシーに指定できるパラメーターの定義。
名前 | 型 | 説明 |
---|---|---|
allowedValues |
object[] |
パラメーターに使用できる値。 |
defaultValue |
object |
値が指定されていない場合のパラメーターの既定値。 |
metadata |
パラメーターの一般的なメタデータ。 |
|
schema |
object |
自己定義 JSON スキーマを使用した割り当て中のパラメーター入力の検証を提供します。 このプロパティは、オブジェクト型パラメーターでのみサポートされ、Json.NET Schema 2019-09 の実装に従います。 スキーマの使用については https://json-schema.org/ で、下書きスキーマのテストについては https://www.jsonschemavalidator.net/ で詳細を参照してください。 |
type |
パラメーターのデータ型です。 |
parameterType
パラメーターのデータ型です。
名前 | 型 | 説明 |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
ParameterValuesValue
パラメーターの値。
名前 | 型 | 説明 |
---|---|---|
value |
object |
パラメーターの値。 |
PolicyDefinitionGroup
ポリシー定義グループ。
名前 | 型 | 説明 |
---|---|---|
additionalMetadataId |
string |
グループに関する追加のメタデータを含むリソースのリソース ID。 |
category |
string |
グループのカテゴリ。 |
description |
string |
グループの説明。 |
displayName |
string |
グループの表示名。 |
name |
string |
グループの名前。 |
PolicyDefinitionReference
ポリシー定義のリファレンス。
名前 | 型 | 説明 |
---|---|---|
groupNames |
string[] |
このポリシー定義が参照するグループの名前。 |
parameters |
<string,
Parameter |
参照されるポリシー 規則のパラメーター値。 キーはパラメーター名です。 |
policyDefinitionId |
string |
ポリシー定義またはポリシー セット定義の ID。 |
policyDefinitionReferenceId |
string |
このポリシー定義リファレンスの (ポリシー セット定義内の) 一意の ID。 |
PolicySetDefinition
ポリシー セットの定義。
名前 | 型 | 説明 |
---|---|---|
id |
string |
ポリシー セット定義の ID。 |
name |
string |
ポリシー セット定義の名前。 |
properties.description |
string |
ポリシー セット定義の説明。 |
properties.displayName |
string |
ポリシー セット定義の表示名。 |
properties.metadata |
object |
ポリシー セット定義メタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキー値ペアのコレクションです。 |
properties.parameters |
<string,
Parameter |
ポリシー定義参照で使用できるポリシー セット定義パラメーター。 |
properties.policyDefinitionGroups |
ポリシー セット定義内のポリシー定義参照のグループを記述するメタデータ。 |
|
properties.policyDefinitions |
ポリシー定義参照の配列。 |
|
properties.policyType |
ポリシー セット定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。 |
|
properties.version |
string |
#.#.# 形式のポリシー セット定義バージョン。 |
properties.versions |
string[] |
このポリシー セット定義で使用できるバージョンの一覧。 |
systemData |
このリソースに関連するシステム メタデータ。 |
|
type |
string |
リソースの種類 (Microsoft.Authorization/policySetDefinitions)。 |
PolicySetDefinitionListResult
ポリシー セット定義の一覧。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
次の結果セットを取得するために使用する URL。 |
value |
ポリシー セット定義の配列。 |
policyType
ポリシー セット定義の種類。 指定できる値は、NotSpecified、BuiltIn、Custom、Static です。
名前 | 型 | 説明 |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |