Policy Assignments - List

Referenz

Service:: Policy

API Version:: 2023-04-01

Ruft alle Richtlinienzuweisungen ab, die für ein Abonnement gelten.
Dieser Vorgang ruft die Liste aller Richtlinienzuweisungen ab, die dem angegebenen Abonnement zugeordnet sind und der optional angegebenen $filter entsprechen. Gültige Werte für $filter sind: "atScope()", "atExactScope()" oder "policyDefinitionId eq "{value}". Wenn $filter nicht bereitgestellt wird, enthält die ungefilterte Liste alle Richtlinienzuweisungen, die dem Abonnement zugeordnet sind, einschließlich derjenigen, die direkt oder aus Verwaltungsgruppen gelten, die das angegebene Abonnement enthalten, sowie alle, die auf Objekte im Abonnement angewendet werden. Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen, die für das Abonnement gelten. Dies ist alles in der ungefilterten Liste mit Ausnahme derjenigen, die auf Objekte angewendet werden, die im Abonnement enthalten sind. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen im Abonnement. Wenn $filter=policyDefinitionId eq '{value}' angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen der Richtliniendefinition, deren ID {value} lautet.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	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: "atScope()", "atExactScope()" oder "policyDefinitionId eq "{value}". Wenn $filter nicht bereitgestellt wird, wird keine Filterung durchgeführt. Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen, die für den Bereich gelten. Dies ist alles in der ungefilterten Liste mit Ausnahme derjenigen, die auf Teilbereiche angewendet werden, die im angegebenen Bereich enthalten sind. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen, die sich im angegebenen Bereich befinden. Wenn $filter=policyDefinitionId eq '{value}' angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen der Richtliniendefinition, deren ID {value} lautet.
$top	query		integer int32	Maximale Anzahl von Datensätzen, die zurückgegeben werden sollen. Wenn der $top-Filter nicht bereitgestellt wird, werden 500 Datensätze zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyAssignmentListResult	OK: Gibt ein Array von Richtlinienzuweisungen 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 policy assignments that apply to a subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "CostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/TagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
enforcementMode	Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine systemseitig zugewiesene Identität oder eine einzelne benutzerseitig zugewiesene Identität.
NonComplianceMessage	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
Override	Der Richtlinieneigenschaftswert überschreibt.
OverrideKind	Die Überschreibungsart.
ParameterValuesValue	Der Wert eines Parameters.
PolicyAssignment	Die Richtlinienzuweisung.
PolicyAssignmentListResult	Liste der Richtlinienzuweisungen.
ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.
ResourceSelector	Der Ressourcenauswahlgeber zum Filtern von Richtlinien nach Ressourceneigenschaften.
Selector	Der Selektorausdruck.
SelectorKind	Die Selektorart.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserAssignedIdentities	Die der Richtlinie zugeordnete Benutzeridentität. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

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

enforcementMode

Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.

Name	Typ	Beschreibung
Default	string	Die Richtlinienauswirkung wird während der Erstellung oder Aktualisierung von Ressourcen erzwungen.
DoNotEnforce	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung nicht erzwungen.

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.

Identity

Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine systemseitig zugewiesene Identität oder eine einzelne benutzerseitig zugewiesene Identität.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.
userAssignedIdentities	UserAssignedIdentities	Die der Richtlinie zugeordnete Benutzeridentität. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.

Name	Typ	Beschreibung
message	string	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie konform ist. Dies wird in den Fehlermeldungen "Verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
policyDefinitionReferenceId	string	Die Referenz-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht bestimmt ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben ist, gilt die Nachricht für alle Richtlinien, die von dieser Richtlinienzuweisung zugewiesen werden.

Override

Der Richtlinieneigenschaftswert überschreibt.

Name	Typ	Beschreibung
kind	OverrideKind	Die Überschreibungsart.
selectors	Selector[]	Die Liste der Selektorausdrücke.
value	string	Der Wert zum Überschreiben der Richtlinieneigenschaft.

OverrideKind

Die Überschreibungsart.

Name	Typ	Beschreibung
policyEffect	string	Er überschreibt den Richtlinieneffekttyp.

ParameterValuesValue

Der Wert eines Parameters.

Name	Typ	Beschreibung
value	object	Der Wert des Parameters.

PolicyAssignment

Die Richtlinienzuweisung.

Name	Typ	Standardwert	Beschreibung
id	string		Die ID der Richtlinienzuweisung.
identity	Identity		Die verwaltete Identität, die der Richtlinienzuweisung zugeordnet ist.
location	string		Der Speicherort der Richtlinienzuweisung. Nur erforderlich, wenn verwaltete Identität verwendet wird.
name	string		Der Name der Richtlinienzuweisung.
properties.description	string		Diese Nachricht ist Teil der Antwort im Falle eines Richtlinienverstoßes.
properties.displayName	string		Der Anzeigename der Richtlinienzuweisung.
properties.enforcementMode	enforcementMode	Default	Der Richtlinienzuweisungserzwingungsmodus. Mögliche Werte sind Default und DoNotEnforce.
properties.metadata	object		Die Metadaten für die Richtlinienzuweisung. Metadaten sind ein offenes Objekt und sind in der Regel eine Auflistung von Schlüsselwertpaaren.
properties.nonComplianceMessages	NonComplianceMessage[]		Die Meldungen, die beschreiben, warum eine Ressource nicht mit der Richtlinie konform ist.
properties.notScopes	string[]		Die ausgeschlossenen Bereiche der Richtlinie.
properties.overrides	Override[]		Der Richtlinieneigenschaftswert überschreibt.
properties.parameters	<string, ParameterValuesValue>		Die Parameterwerte für die zugewiesene Richtlinienregel. Die Schlüssel sind die Parameternamen.
properties.policyDefinitionId	string		Die ID der zugewiesenen Richtliniendefinition oder Richtliniensatzdefinition.
properties.resourceSelectors	ResourceSelector[]		Die Ressourcenauswahlliste zum Filtern von Richtlinien nach Ressourceneigenschaften.
properties.scope	string		Der Bereich für die Richtlinienzuweisung.
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string		Der Typ der Richtlinienzuweisung.

PolicyAssignmentListResult

Liste der Richtlinienzuweisungen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen der nächsten Ergebnismenge verwendet werden soll.
value	PolicyAssignment[]	Ein Array von Richtlinienzuweisungen.

ResourceIdentityType

Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer system- oder benutzerseitig zugewiesenen Identität zu einer Ressource.

Name	Typ	Beschreibung
None	string	Gibt an, dass der Ressource keine Identität zugeordnet ist oder dass die vorhandene Identität entfernt werden soll.
SystemAssigned	string	Gibt an, dass der Ressource eine systemseitig zugewiesene Identität zugeordnet ist.
UserAssigned	string	Gibt an, dass der Ressource eine systemseitig zugewiesene Identität zugeordnet ist.

ResourceSelector

Der Ressourcenauswahlgeber zum Filtern von Richtlinien nach Ressourceneigenschaften.

Name	Typ	Beschreibung
name	string	Der Name des Ressourcenauswahlors.
selectors	Selector[]	Die Liste der Selektorausdrücke.

Selector

Der Selektorausdruck.

Name	Typ	Beschreibung
in	string[]	Die Liste der zu filternden Werte.
kind	SelectorKind	Die Selektorart.
notIn	string[]	Die Liste der zu filternden Werte.

SelectorKind

Die Selektorart.

Name	Typ	Beschreibung
policyDefinitionReferenceId	string	Die Selektorart zum Filtern von Richtlinien nach der Referenz-ID der Richtliniendefinition.
resourceLocation	string	Die Selektorart zum Filtern von Richtlinien nach dem Ressourcenspeicherort.
resourceType	string	Die Selektorart zum Filtern von Richtlinien nach dem Ressourcentyp.
resourceWithoutLocation	string	Die Selektorart zum Filtern von Richtlinien nach der Ressource ohne Speicherort.

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.

UserAssignedIdentities

Die der Richtlinie zugeordnete Benutzeridentität. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Typ	Beschreibung

Share via