Policy Set Definitions - List

Service:

Policy

API Version:

2023-04-01

Lekéri egy előfizetés szabályzatkészlet-definícióit.
Ez a művelet lekéri egy adott előfizetés összes szabályzatkészlet-definíciójának listáját, amely megfelel az opcionális $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 az előfizetéshez társított összes szabályzatkészlet-definíciót, beleértve azokat is, amelyek közvetlenül vagy az adott előfizetést tartalmazó felügyeleti csoportokból származnak. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott előfizetésben 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/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string uuid	A cél-előfizetés azonosítója. Az értéknek UUID-nak kell lennie.
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	PolicySetDefinitionListResult	OK – Szabályzatkészlet-definíciók tömbjének visszaadása.
Other Status Codes	CloudError	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

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_policy_set_definitions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_set_definitions.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/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": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Definíciók

Name	Description
CloudError	Egy szabályzatművelet hibaválasza.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
Metadata	A paraméter általános metaadatai.
ParameterDefinitionsValue	A szabályzathoz megadható paraméter definíciója.
parameterType	A paraméter adattípusa.
ParameterValuesValue	Egy paraméter értéke.
PolicyDefinitionGroup	A szabályzatdefiníciós csoport.
PolicyDefinitionReference	A szabályzatdefiníció referenciája.
PolicySetDefinition	A szabályzatkészlet definíciója.
PolicySetDefinitionListResult	Szabályzatkészlet-definíciók listája.
policyType	A szabályzatkészlet definíciójának típusa. Lehetséges értékek: NotSpecified, BuiltIn, Custom és Static.
systemData	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	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

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	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	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	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	parameterType	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,  ParameterValuesValue>	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,  ParameterDefinitionsValue>	A szabályzatdefiníciós hivatkozásokban használható szabályzatkészlet-definíciós paraméterek.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	A szabályzatdefiníciók csoportjait leíró metaadatok a szabályzatkészlet-definíción belül.
properties.policyDefinitions	PolicyDefinitionReference[]	Szabályzatdefiníciós hivatkozások tömbje.
properties.policyType	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	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	PolicySetDefinition[]	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	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	createdByType	Az erőforrást legutóbb módosító identitás típusa.