Policy Definition Versions - List

Service:

Policy

API-versie:

2023-04-01

Hiermee worden beleidsdefinitieversies opgehaald voor een bepaalde beleidsdefinitie in een abonnement
Met deze bewerking wordt een lijst opgehaald met alle beleidsdefinitieversies voor de opgegeven beleidsdefinitie.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions?api-version=2023-04-01

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
policyDefinitionName	path	True	string pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$	De naam van de beleidsdefinitie.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$top	query		integer (int32) minimum: 1 maximum: 1000	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	PolicyDefinitionVersionListResult	OK: retourneert een matrix met beleidsdefinitieversies.
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 policy definition versions by subscription

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions?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_definition_versions.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="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_definition_versions.list(
        policy_definition_name="ResourceNaming",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyDefinitionVersions.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": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.2.1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.0.0",
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '-*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/versions/1.0.0",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "1.0.0"
    }
  ]
}

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.
PolicyDefinitionVersion	De id van de beleidsdefinitieversie.
PolicyDefinitionVersionListResult	Lijst met beleidsdefinitieversies.
policyType	Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Object

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

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorResponse

Object

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

Object

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

Object

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

Inventarisatie

Het gegevenstype van de parameter.

Waarde	Description
Array
Boolean
DateTime
Float
Integer
Object
String

PolicyDefinitionVersion

Object

De id van de beleidsdefinitieversie.

Name	Type	Default value	Description
id	string		De id van de beleidsdefinitieversie.
name	string		De naam van de beleidsdefinitieversie.
properties.description	string		De beschrijving van de beleidsdefinitie.
properties.displayName	string		De weergavenaam van de beleidsdefinitie.
properties.metadata	object		De metagegevens van de beleidsdefinitie. Metagegevens zijn een geopend object en zijn meestal een verzameling sleutel-waardeparen.
properties.mode	string	Indexed	De beleidsdefinitiemodus. Enkele voorbeelden zijn Alle, Geïndexeerd, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>		De parameterdefinities voor parameters die worden gebruikt in de beleidsregel. De sleutels zijn de parameternamen.
properties.policyRule	object		De beleidsregel.
properties.policyType	policyType		Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
properties.version	string		De beleidsdefinitieversie in #.#.#-indeling.
systemData	systemData		De systeemmetagegevens met betrekking tot deze resource.
type	string		Het type resource (Microsoft.Authorization/policyDefinitions/versions).

PolicyDefinitionVersionListResult

Object

Lijst met beleidsdefinitieversies.

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

policyType

Inventarisatie

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

Waarde	Description
BuiltIn
Custom
NotSpecified
Static

systemData

Object

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

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