Policy Definition Versions - List Built In

Referentie

Service:: Policy

API Version:: 2023-04-01

Ingebouwde beleidsdefinitieversies ophalen
Met deze bewerking wordt een lijst opgehaald met alle ingebouwde beleidsdefinitieversies voor de opgegeven beleidsdefinitie.

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

With optional parameters:

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
policyDefinitionName	path	True	string	De naam van de beleidsdefinitie. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$top	query		integer int32	Maximum aantal records dat moet worden geretourneerd. Wanneer het $top filter niet is opgegeven, worden 500 records geretourneerd.

policyDefinitionName

path

True

string

De naam van de beleidsdefinitie.

Regex pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

api-version

query

True

string

De API-versie die voor deze bewerking moet worden gebruikt.

$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	PolicyDefinitionVersionListResult	OK: retourneert een matrix met ingebouwde beleidsdefinitieversies.
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 built-in policy definition versions

GET https://management.azure.com/providers/Microsoft.Authorization/policyDefinitions/06a78e20-9358-41c9-923c-fb736d382a12/versions?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_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(),
        policy_definition_name="06a78e20-9358-41c9-923c-fb736d382a12",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicyDefinitionVersions.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": {
        "mode": "All",
        "displayName": "Audit SQL DB Level Audit Setting",
        "policyType": "BuiltIn",
        "description": "Audit DB level audit setting for SQL databases",
        "parameters": {
          "setting": {
            "type": "String",
            "metadata": {
              "displayName": "Audit Setting"
            },
            "allowedValues": [
              "enabled",
              "disabled"
            ]
          }
        },
        "version": "1.2.1",
        "policyRule": {
          "if": {
            "field": "type",
            "equals": "Microsoft.Sql/servers/databases"
          },
          "then": {
            "effect": "AuditIfNotExists",
            "details": {
              "type": "Microsoft.Sql/servers/databases/auditingSettings",
              "name": "default",
              "existenceCondition": {
                "allOf": [
                  {
                    "field": "Microsoft.Sql/auditingSettings.state",
                    "equals": "[parameters('setting')]"
                  }
                ]
              }
            }
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/06a78e20-9358-41c9-923c-fb736d382a12/versions/1.2.1",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.2.1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Audit SQL DB Level Audit Setting",
        "policyType": "BuiltIn",
        "description": "Audit DB level audit setting for SQL databases",
        "parameters": {
          "setting": {
            "type": "String",
            "metadata": {
              "displayName": "Audit Setting"
            },
            "allowedValues": [
              "enabled",
              "disabled",
              "default"
            ]
          }
        },
        "version": "1.0.0",
        "policyRule": {
          "if": {
            "field": "type",
            "equals": "Microsoft.Sql/servers/databases"
          },
          "then": {
            "effect": "AuditIfNotExists",
            "details": {
              "type": "Microsoft.Sql/servers/databases/auditingSettings",
              "name": "default",
              "existenceCondition": {
                "allOf": [
                  {
                    "field": "Microsoft.Sql/auditingSettings.state",
                    "equals": "[parameters('setting')]"
                  }
                ]
              }
            }
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/06a78e20-9358-41c9-923c-fb736d382a12/versions/1.0.0",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.0.0"
    }
  ]
}

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 voor het beleid.
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 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 OData-foutreactieindeling.)

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[]	Aanvullende informatie over de fout.
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 tijdens beleidstoewijzingen roltoewijzingen te maken voor de resource-id of resourcebereikwaarde van deze parameter Azure Portal. 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 voor 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 van Json.NET Schema 2019-09. Meer informatie over het gebruik van schema's vindt u op https://json-schema.org/ en testconceptschema'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