Policy Set Definitions - List By Management Group
Lekéri a felügyeleti csoport összes szabályzatkészlet-definícióját.
Ez a művelet lekéri egy adott felügyeleti csoport összes szabályzatkészlet-definíciójának listáját, amely megfelel a választható $filter. A $filter érvényes értékei a következők: "atExactScope()", "policyType -eq {value}" vagy "category eq "{value}". Ha $filter nincs megadva, a szűretlen lista tartalmazza a felügyeleti csoporthoz társított összes szabályzatkészlet-definíciót, beleértve azokat is, amelyek közvetlenül vagy az adott felügyeleti csoportot tartalmazó felügyeleti csoportokból származnak. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott felügyeleti csoportban található összes szabályzatkészlet-definíciót tartalmazza. Ha $filter='policyType -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatkészlet-definíciót tartalmazza, amelynek típusa megegyezik a(z) {value} típussal. A policyType lehetséges értékei nem meghatározottak, Beépítettek és Egyéniek. Ha $filter='category -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatkészlet-definíciót tartalmazza, amelyek kategóriája megegyezik a(z) {value} értékkel.
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-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
management
|
path | True |
string |
A felügyeleti csoport azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
$filter
|
query |
string |
A műveletre alkalmazandó szűrő. A $filter érvényes értékei a következők: "atExactScope()", "policyType -eq {value}" vagy "category eq "{value}". Ha $filter nincs megadva, a szűrés nem történik meg. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott hatókörben lévő összes szabályzatkészlet-definíciót tartalmazza. Ha $filter='policyType -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatkészlet-definíciót tartalmazza, amelynek típusa megegyezik a(z) {value} típussal. A policyType lehetséges értékei: NotSpecified, BuiltIn, Custom és Static. Ha $filter='category -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatkészlet-definíciót tartalmazza, amelyek kategóriája megegyezik a(z) {value} értékkel. |
|
$top
|
query |
integer int32 |
A visszaadandó rekordok maximális száma. Ha a $top szűrő nincs megadva, 500 rekordot ad vissza. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK – Szabályzatkészlet-definíciók tömbjének visszaadása. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
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"
}
}
}
]
}
}
]
}
Definíciók
Name | Description |
---|---|
Cloud |
Egy szabályzatművelet hibaválasza. |
created |
Az erőforrást létrehozó identitás típusa. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
Metadata |
A paraméter általános metaadatai. |
Parameter |
A szabályzathoz megadható paraméter definíciója. |
parameter |
A paraméter adattípusa. |
Parameter |
Egy paraméter értéke. |
Policy |
A szabályzatdefiníciós csoport. |
Policy |
A szabályzatdefiníció referenciája. |
Policy |
A szabályzatkészlet definíciója. |
Policy |
Szabályzatkészlet-definíciók listája. |
policy |
A szabályzatkészlet definíciójának típusa. Lehetséges értékek: NotSpecified, BuiltIn, Custom és Static. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
CloudError
Egy szabályzatművelet hibaválasza.
Name | Típus | Description |
---|---|---|
error |
Hibaválasz |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
Metadata
A paraméter általános metaadatai.
Name | Típus | Description |
---|---|---|
assignPermissions |
boolean |
Állítsa igaz értékre, hogy Azure Portal szerepkör-hozzárendeléseket hozzon létre a paraméter erőforrás-azonosítóján vagy erőforrás-hatókörének értékén a szabályzat-hozzárendelés során. Ez a tulajdonság akkor hasznos, ha a hozzárendelés hatókörén kívül szeretne engedélyeket hozzárendelni. |
description |
string |
A paraméter leírása. |
displayName |
string |
A paraméter megjelenítendő neve. |
strongType |
string |
A szabályzatdefiníció portálon keresztüli hozzárendeléséhez használatos. A felhasználó számára kiválasztandó értékek környezetfüggő listáját tartalmazza. |
ParameterDefinitionsValue
A szabályzathoz megadható paraméter definíciója.
Name | Típus | Description |
---|---|---|
allowedValues |
object[] |
A paraméter engedélyezett értékei. |
defaultValue |
object |
A paraméter alapértelmezett értéke, ha nincs megadva érték. |
metadata |
A paraméter általános metaadatai. |
|
schema |
object |
A paraméterbemenetek ellenőrzését biztosítja a hozzárendelés során egy ön definiált JSON-sémával. Ez a tulajdonság csak objektumtípus-paraméterek esetén támogatott, és a Json.NET Schema 2019-09 implementációt követi. A sémák használatáról és a vázlatsémák https://json-schema.org/ teszteléséről a következő címen tudhat meg többet: https://www.jsonschemavalidator.net/. |
type |
A paraméter adattípusa. |
parameterType
A paraméter adattípusa.
Name | Típus | Description |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
ParameterValuesValue
Egy paraméter értéke.
Name | Típus | Description |
---|---|---|
value |
object |
A paraméter értéke. |
PolicyDefinitionGroup
A szabályzatdefiníciós csoport.
Name | Típus | Description |
---|---|---|
additionalMetadataId |
string |
Egy erőforrás erőforrás-azonosítója, amely további metaadatokat tartalmaz a csoportról. |
category |
string |
A csoport kategóriája. |
description |
string |
A csoport leírása. |
displayName |
string |
A csoport megjelenítendő neve. |
name |
string |
A csoport neve. |
PolicyDefinitionReference
A szabályzatdefiníció referenciája.
Name | Típus | Description |
---|---|---|
groupNames |
string[] |
Azon csoportok neve, amelyekhez ez a szabályzatdefiníció-hivatkozás tartozik. |
parameters |
<string,
Parameter |
A hivatkozott szabályzatszabály paraméterértékei. A kulcsok a paraméternevek. |
policyDefinitionId |
string |
A szabályzatdefiníció vagy a szabályzatkészlet-definíció azonosítója. |
policyDefinitionReferenceId |
string |
A szabályzatdefiníciós referencia egyedi azonosítója (a szabályzatkészlet-definíción belül). |
PolicySetDefinition
A szabályzatkészlet definíciója.
Name | Típus | Description |
---|---|---|
id |
string |
A szabályzatkészlet-definíció azonosítója. |
name |
string |
A szabályzatkészlet-definíció neve. |
properties.description |
string |
A szabályzatkészlet definíciójának leírása. |
properties.displayName |
string |
A szabályzatkészlet-definíció megjelenítendő neve. |
properties.metadata |
object |
A szabályzatkészlet definíciójának metaadatai. A metaadatok egy nyitott befejezett objektum, amely általában kulcsértékpárok gyűjteménye. |
properties.parameters |
<string,
Parameter |
A szabályzatdefiníciós hivatkozásokban használható szabályzatkészlet-definíciós paraméterek. |
properties.policyDefinitionGroups |
A szabályzatdefiníciók csoportjait leíró metaadatok a szabályzatkészlet-definíción belül. |
|
properties.policyDefinitions |
Szabályzatdefiníciós hivatkozások tömbje. |
|
properties.policyType |
A szabályzatkészlet definíciójának típusa. Lehetséges értékek: NotSpecified, BuiltIn, Custom és Static. |
|
properties.version |
string |
A szabályzatkészlet definíciójának verziója #.#.# formátumban. |
properties.versions |
string[] |
A szabályzatkészlet-definíció elérhető verzióinak listája. |
systemData |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
|
type |
string |
Az erőforrás típusa (Microsoft.Authorization/policySetDefinitions). |
PolicySetDefinitionListResult
Szabályzatkészlet-definíciók listája.
Name | Típus | Description |
---|---|---|
nextLink |
string |
A következő találatok lekéréséhez használandó URL-cím. |
value |
Szabályzatkészlet-definíciók tömbje. |
policyType
A szabályzatkészlet definíciójának típusa. Lehetséges értékek: NotSpecified, BuiltIn, Custom és Static.
Name | Típus | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az az identitás, amely legutóbb módosította az erőforrást. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |