Policy Set Definitions - List

Service:

Policy

API Version:

2023-04-01

Hiermee haalt u de beleidssetdefinities voor een abonnement op.
Met deze bewerking wordt een lijst opgehaald met alle beleidssetdefinities in een bepaald abonnement die overeenkomen met de optionele $filter. Geldige waarden voor $filter zijn: 'atExactScope()', 'policyType -eq {value}' of 'category eq '{value}'. Als $filter niet is opgegeven, bevat de niet-gefilterde lijst alle definities van de beleidsset die zijn gekoppeld aan het abonnement, inclusief de definities die rechtstreeks van toepassing zijn of van beheergroepen die het opgegeven abonnement bevatten. Als $filter=atExactScope() wordt opgegeven, bevat de geretourneerde lijst alleen alle beleidssetdefinities die in het opgegeven abonnement zijn opgenomen. Als $filter='policyType -eq {value}' is opgegeven, bevat de geretourneerde lijst alleen alle definities van de beleidsset waarvan het type overeenkomt met {value}. Mogelijke policyType-waarden zijn NotSpecified, BuiltIn en Custom. Als $filter='category -eq {value}' is opgegeven, bevat de geretourneerde lijst alleen alle beleidssetdefinities waarvan de categorie overeenkomt met {value}.

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-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string uuid	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Het filter dat moet worden toegepast op de bewerking. Geldige waarden voor $filter zijn: 'atExactScope()', 'policyType -eq {value}' of 'category eq '{value}'. Als $filter niet is opgegeven, wordt er geen filter uitgevoerd. Als $filter=atExactScope() is opgegeven, bevat de geretourneerde lijst alleen alle beleidssetdefinities die binnen het opgegeven bereik vallen. Als $filter='policyType -eq {value}' is opgegeven, bevat de geretourneerde lijst alleen alle definities van de beleidsset waarvan het type overeenkomt met {value}. Mogelijke policyType-waarden zijn NotSpecified, BuiltIn, Custom en Static. Als $filter='category -eq {value}' is opgegeven, bevat de geretourneerde lijst alleen alle beleidssetdefinities waarvan de categorie overeenkomt met {value}.
$top	query		integer int32	Maximum aantal records dat moet worden geretourneerd. Wanneer het $top filter niet is opgegeven, worden 500 records geretourneerd.

Antwoorden

Name	Type	Description
200 OK	PolicySetDefinitionListResult	OK: retourneert een matrix met definities van beleidssets.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definities

Name	Description
CloudError	Een foutreactie van een beleidsbewerking.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
Metadata	Algemene metagegevens voor de parameter.
ParameterDefinitionsValue	De definitie van een parameter die kan worden opgegeven aan het beleid.
parameterType	Het gegevenstype van de parameter.
ParameterValuesValue	De waarde van een parameter.
PolicyDefinitionGroup	De beleidsdefinitiegroep.
PolicyDefinitionReference	De naslaginformatie over de beleidsdefinitie.
PolicySetDefinition	De definitie van de beleidsset.
PolicySetDefinitionListResult	Lijst met definities van beleidssets.
policyType	Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

CloudError

Een foutreactie van een beleidsbewerking.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

Metadata

Algemene metagegevens voor de parameter.

Name	Type	Description
assignPermissions	boolean	Stel in op true om Azure Portal roltoewijzingen te laten maken op de resource-id of resourcebereikwaarde van deze parameter tijdens de beleidstoewijzing. Deze eigenschap is handig als u machtigingen buiten het toewijzingsbereik wilt toewijzen.
description	string	De beschrijving van de parameter.
displayName	string	De weergavenaam voor de parameter.
strongType	string	Wordt gebruikt bij het toewijzen van de beleidsdefinitie via de portal. Biedt een contextbewuste lijst met waarden waaruit de gebruiker kan kiezen.

ParameterDefinitionsValue

De definitie van een parameter die kan worden opgegeven aan het beleid.

Name	Type	Description
allowedValues	object[]	De toegestane waarden voor de parameter.
defaultValue	object	De standaardwaarde voor de parameter als er geen waarde is opgegeven.
metadata	Metadata	Algemene metagegevens voor de parameter.
schema	object	Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelf-gedefinieerd JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de implementatie Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en test conceptschema's op https://www.jsonschemavalidator.net/.
type	parameterType	Het gegevenstype van de parameter.

parameterType

Het gegevenstype van de parameter.

Name	Type	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

De waarde van een parameter.

Name	Type	Description
value	object	De waarde van de parameter.

PolicyDefinitionGroup

De beleidsdefinitiegroep.

Name	Type	Description
additionalMetadataId	string	Een resource-id van een resource die aanvullende metagegevens over de groep bevat.
category	string	De categorie van de groep.
description	string	De beschrijving van de groep.
displayName	string	De weergavenaam van de groep.
name	string	De naam van de groep.

PolicyDefinitionReference

De naslaginformatie over de beleidsdefinitie.

Name	Type	Description
groupNames	string[]	De naam van de groepen waartoe deze beleidsdefinitie verwijst.
parameters	<string,  ParameterValuesValue>	De parameterwaarden voor de beleidsregel waarnaar wordt verwezen. De sleutels zijn de parameternamen.
policyDefinitionId	string	De id van de beleidsdefinitie of beleidssetdefinitie.
policyDefinitionReferenceId	string	Een unieke id (binnen de definitie van de beleidsset) voor deze naslaginformatie over beleidsdefinities.

PolicySetDefinition

De definitie van de beleidsset.

Name	Type	Description
id	string	De id van de definitie van de beleidsset.
name	string	De naam van de definitie van de beleidsset.
properties.description	string	De beschrijving van de definitie van de beleidsset.
properties.displayName	string	De weergavenaam van de definitie van de beleidsset.
properties.metadata	object	De metagegevens van de definitie van de beleidsset. Metagegevens zijn een open-eindobject en zijn meestal een verzameling sleutelwaardeparen.
properties.parameters	<string,  ParameterDefinitionsValue>	De definitieparameters van de beleidsset die kunnen worden gebruikt in verwijzingen naar beleidsdefinities.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	De metagegevens die groepen verwijzingen naar beleidsdefinities binnen de definitie van de beleidsset beschrijven.
properties.policyDefinitions	PolicyDefinitionReference[]	Een matrix met verwijzingen naar beleidsdefinities.
properties.policyType	policyType	Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
properties.version	string	De definitieversie van de beleidsset in #.#.#-indeling.
properties.versions	string[]	Een lijst met beschikbare versies voor deze beleidssetdefinitie.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

Lijst met definities van beleidssets.

Name	Type	Description
nextLink	string	De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten.
value	PolicySetDefinition[]	Een matrix met definities van beleidssets.

policyType

Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

Name	Type	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.