Policy Definitions - List
Ruft Richtliniendefinitionen in einem Abonnement ab.
Dieser Vorgang ruft eine Liste aller Richtliniendefinitionen in einem bestimmten Abonnement ab, die dem optionalen angegebenen $filter entsprechen. Gültige Werte für $filter sind: "atExactScope()", "policyType -eq {value}" oder "category eq "{value}". Wenn $filter nicht bereitgestellt wird, enthält die ungefilterte Liste alle Richtliniendefinitionen, die dem Abonnement zugeordnet sind, einschließlich der Richtliniendefinitionen, die direkt oder aus Verwaltungsgruppen angewendet werden, die das angegebene Abonnement enthalten. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniendefinitionen, die im angegebenen Abonnement enthalten sind. 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.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
subscription
|
path | True |
string uuid |
Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein. |
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 |
OK: Gibt ein Array von Richtliniendefinitionen zurück. |
|
Other Status Codes |
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 policy definitions by subscription
Sample Request
Sample Response
{
"value": [
{
"properties": {
"mode": "All",
"displayName": "Allowed storage account SKUs",
"policyType": "BuiltIn",
"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": "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",
"versions": [
"1.2.1",
"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/ResourceNaming",
"type": "Microsoft.Authorization/policyDefinitions",
"name": "ResourceNaming"
},
{
"properties": {
"mode": "Microsoft.KeyVault.Data",
"displayName": "Audit KeyVault certificates that expire within specified number of days",
"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"
}
},
"policyType": "Custom"
},
"id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/AuditSoonToExpireCerts",
"type": "Microsoft.Authorization/policyDefinitions",
"name": "AuditSoonToExpireCerts"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Cloud |
Eine Fehlerantwort eines Richtlinienvorgangs. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Fehlerantwort |
Metadata |
Allgemeine Metadaten für den Parameter. |
Parameter |
Die Definition eines Parameters, der für die Richtlinie bereitgestellt werden kann. |
parameter |
Der Datentyp des Parameters. |
Policy |
Die Richtliniendefinition. |
Policy |
Liste der Richtliniendefinitionen. |
policy |
Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
CloudError
Eine Fehlerantwort eines Richtlinienvorgangs.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerantwort |
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 |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
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 |
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 |
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,
Parameter |
Die Parameterdefinitionen für Parameter, die in der Richtlinienregel verwendet werden. Die Schlüssel sind die Parameternamen. |
|
properties.policyRule |
object |
Die Richtlinienregel. |
|
properties.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 |
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 |
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 |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |