Policy Set Definitions - List Built In

Referentie

Service:: Policy

API-versie:: 2023-04-01

Hiermee worden ingebouwde definities van beleidssets opgehaald.
Met deze bewerking wordt een lijst opgehaald met alle ingebouwde definities van beleidssets die overeenkomen met de optionele gegeven $filter. Als $filter='category -eq {value}' is opgegeven, bevat de geretourneerde lijst alleen alle ingebouwde beleidssetdefinities waarvan de categorie overeenkomt met de {value}.

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$expand	query		string	Door komma's gescheiden lijst met aanvullende eigenschappen die moeten worden opgenomen in het antwoord. Ondersteunde waarden zijn 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
$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 beleidssetdefinities waarvan het type overeenkomt met de {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 de {value}.
$top	query		integer int32	Maximum aantal records dat moet worden geretourneerd. Wanneer het $top filter niet is opgegeven, worden er 500 records geretourneerd.

Antwoorden

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

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List built-in policy set definitions

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_built_in_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(),
        subscription_id="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.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

Voorbeeldrespons

Statuscode:: 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",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId1"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId2"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId3"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId4"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId5"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId6"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId7"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId8"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId9"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId10"
          }
        ]
      },
      "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    }
  ]
}

Definities

Name	Description
CloudError	Een foutbericht 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 aan het beleid kan worden verstrekt.
parameterType	Het gegevenstype van de parameter.
ParameterValuesValue	De waarde van een parameter.
PolicyDefinitionGroup	De beleidsdefinitiegroep.
PolicyDefinitionReference	De verwijzing naar de beleidsdefinitie.
PolicySetDefinition	De definitie van de beleidsset.
PolicySetDefinitionListResult	Lijst met beleidssetdefinities.
policyType	Het type beleidssetdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Een foutbericht van een beleidsbewerking.

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

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 extra informatietype.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat 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	Ingesteld op waar als u azure Portal roltoewijzingen wilt laten maken voor de resource-id of resourcebereikwaarde van deze parameter tijdens het toewijzen van het beleid. Deze eigenschap is handig als u machtigingen wilt toewijzen buiten het toewijzingsbereik.
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 aan het beleid kan worden verstrekt.

Name	Type	Description
allowedValues	object[]	De toegestane waarden voor de parameter.
defaultValue	object	De standaardwaarde voor de parameter als er geen waarde wordt opgegeven.
metadata	Metadata	Algemene metagegevens voor de parameter.
schema	object	Biedt validatie van parameterinvoer tijdens de toewijzing met behulp van een zelfgedefinieerde JSON-schema. Deze eigenschap wordt alleen ondersteund voor objecttypeparameters en volgt de Json.NET Schema 2019-09-implementatie. U vindt meer informatie over het gebruik van schema's op https://json-schema.org/ en het testen van 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 verwijzing naar de beleidsdefinitie.

Name	Type	Description
definitionVersion	string	De versie van de te gebruiken beleidsdefinitie.
effectiveDefinitionVersion	string	De effectieve versie van de gebruikte beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
groupNames	string[]	De naam van de groepen waartoe deze beleidsdefinitiereferentie behoort.
latestDefinitionVersion	string	De nieuwste versie van de beschikbare beleidsdefinitie. Dit is alleen aanwezig als dit wordt aangevraagd via de $expand queryparameter.
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.