Policy Definitions - List Built In

Service:

Policy

API Version:

2023-04-01

Abrufen integrierter Richtliniendefinitionen
Dieser Vorgang ruft eine Liste aller integrierten Richtliniendefinitionen ab, die den optionalen angegebenen $filter entsprechen. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle integrierten Richtliniendefinitionen, deren Typ mit dem {value} übereinstimmt. Mögliche policyType-Werte sind NotSpecified, BuiltIn, Custom und Static. Wenn $filter='category -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle integrierten Richtliniendefinitionen, deren Kategorie mit dem {value} übereinstimmt.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll. Gültige Werte für $filter sind: "atExactScope()", "policyType -eq {value}" oder "category eq "{value}". Wenn $filter nicht bereitgestellt wird, wird keine Filterung durchgeführt. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniendefinitionen, die sich im angegebenen Bereich befinden. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniendefinitionen, deren Typ mit dem {value} übereinstimmt. Mögliche policyType-Werte sind NotSpecified, BuiltIn, Custom und Static. Wenn $filter='category -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniendefinitionen, deren Kategorie mit dem {value} übereinstimmt.
$top	query		integer int32	Maximale Anzahl von zurückzugebenden Datensätzen. Wenn der $top Filter nicht bereitgestellt wird, gibt er 500 Datensätze zurück.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyDefinitionListResult	OK: Gibt ein Array von integrierten Richtliniendefinitionen zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

List built-in policy definitions

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Authorization/policyDefinitions?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_built_in_policy_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="SUBSCRIPTION_ID",
    )

    response = client.policy_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/listBuiltInPolicyDefinitions.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",
        "versions": [
          "1.2.1",
          "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",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "06a78e20-9358-41c9-923c-fb736d382a12"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Allowed storage account SKUs",
        "policyType": "Static",
        "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.",
        "parameters": {
          "listOfAllowedSKUs": {
            "type": "Array",
            "metadata": {
              "description": "The list of SKUs that can be specified for storage accounts.",
              "displayName": "Allowed SKUs",
              "strongType": "StorageSKUs"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "allOf": [
              {
                "field": "type",
                "equals": "Microsoft.Storage/storageAccounts"
              },
              {
                "not": {
                  "field": "Microsoft.Storage/storageAccounts/sku.name",
                  "in": "[parameters('listOfAllowedSKUs')]"
                }
              }
            ]
          },
          "then": {
            "effect": "Deny"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1"
    },
    {
      "properties": {
        "mode": "Microsoft.KeyVault.Data",
        "displayName": "Audit KeyVault certificates that expire within specified number of days",
        "policyType": "BuiltIn",
        "description": "Audit certificates that are stored in Azure Key Vault, that expire within 'X' number of days.",
        "metadata": {
          "category": "KeyVault DataPlane"
        },
        "parameters": {
          "daysToExpire": {
            "type": "Integer",
            "metadata": {
              "displayName": "Days to expire",
              "description": "The number of days for a certificate to expire."
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "field": "Microsoft.KeyVault.Data/vaults/certificates/attributes/expiresOn",
            "lessOrEquals": "[addDays(utcNow(), parameters('daysToExpire'))]"
          },
          "then": {
            "effect": "audit"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/abeed54a-73c5-441d-8a8c-6b5e7a0c299e",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "abeed54a-73c5-441d-8a8c-6b5e7a0c299e"
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
Metadata	Allgemeine Metadaten für den Parameter.
ParameterDefinitionsValue	Die Definition eines Parameters, der für die Richtlinie bereitgestellt werden kann.
parameterType	Der Datentyp des Parameters.
PolicyDefinition	Die Richtliniendefinition.
PolicyDefinitionListResult	Liste der Richtliniendefinitionen.
policyType	Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Metadata

Allgemeine Metadaten für den Parameter.

Name	Typ	Beschreibung
assignPermissions	boolean	Legen Sie diesen Wert auf true fest, damit Azure-Portal während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellen. Diese Eigenschaft ist hilfreich, wenn Sie Berechtigungen außerhalb des Zuweisungsbereichs zuweisen möchten.
description	string	Die Beschreibung des Parameters.
displayName	string	Der Anzeigename für den Parameter.
strongType	string	Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste von Werten bereit, aus der der Benutzer auswählen kann.

ParameterDefinitionsValue

Die Definition eines Parameters, der für die Richtlinie bereitgestellt werden kann.

Name	Typ	Beschreibung
allowedValues	object[]	Die zulässigen Werte für den Parameter.
defaultValue	object	Der Standardwert für den Parameter, wenn kein Wert angegeben wird.
metadata	Metadata	Allgemeine Metadaten für den Parameter.
schema	object	Ermöglicht die Validierung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der 2019-09-Implementierung des Json.NET-Schemas. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/. Das Testen von Schemas ist unter https://www.jsonschemavalidator.net/ möglich.
type	parameterType	Der Datentyp des Parameters.

parameterType

Der Datentyp des Parameters.

Name	Typ	Beschreibung
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

PolicyDefinition

Die Richtliniendefinition.

Name	Typ	Standardwert	Beschreibung
id	string		Die ID der Richtliniendefinition.
name	string		Der Name der Richtliniendefinition.
properties.description	string		Die Beschreibung der Richtliniendefinition.
properties.displayName	string		Der Anzeigename der Richtliniendefinition.
properties.metadata	object		Die Metadaten der Richtliniendefinition. Metadaten sind ein offenes Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.mode	string	Indexed	Der Richtliniendefinitionsmodus. Einige Beispiele sind All, Indexed, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>		Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen.
properties.policyRule	object		Die Richtlinienregel.
properties.policyType	policyType		Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
properties.version	string		Die Richtliniendefinitionsversion im #.#.#.#-Format.
properties.versions	string[]		Eine Liste der verfügbaren Versionen für diese Richtliniendefinition.
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string		Der Typ der Ressource (Microsoft.Authorization/policyDefinitions).

PolicyDefinitionListResult

Liste der Richtliniendefinitionen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	PolicyDefinition[]	Ein Array von Richtliniendefinitionen.

policyType

Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.

Name	Typ	Beschreibung
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.