Policy Assignments - List For Management Group

Referenz

Service:: Policy

API Version:: 2023-04-01

Ruft alle Richtlinienzuweisungen ab, die für eine Verwaltungsgruppe gelten.
Dieser Vorgang ruft die Liste aller Richtlinienzuweisungen ab, die für die Verwaltungsgruppe gelten, die dem angegebenen $filter entsprechen. Gültige Werte für $filter sind: "atScope()", "atExactScope()" oder "policyDefinitionId eq "{value}". Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen, die der Verwaltungsgruppe oder den Vorgängern der Verwaltungsgruppe zugewiesen sind. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen der Verwaltungsgruppe. Wenn $filter=policyDefinitionId eq '{value}' angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen der Richtliniendefinition, deren ID {value} lautet, die für die Verwaltungsgruppe gelten.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
managementGroupId	path	True	string	Die ID der Verwaltungsgruppe.
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 management group

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestCostManagement",
      "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": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup",
        "notScopes": []
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TestTagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup",
        "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 vom Benutzer 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 Konformitätsergebnissen der Ressource gezeigt.
Override	Der Wert der Richtlinieneigenschaft wird außer Kraft gesetzt.
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, wenn einer Ressource eine system- oder benutzerseitig zugewiesene Identität hinzugefügt wird.
ResourceSelector	Die Ressourcenauswahl 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. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{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 vom Benutzer 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, wenn einer Ressource eine system- oder benutzerseitig zugewiesene Identität hinzugefügt wird.
userAssignedIdentities	UserAssignedIdentities	Die der Richtlinie zugeordnete Benutzeridentität. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{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 Konformitätsergebnissen der Ressource gezeigt.

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 Konformitätsergebnissen der Ressource gezeigt.
policyDefinitionReferenceId	string	Die Verweis-ID der Richtliniendefinition innerhalb einer Richtliniensatzdefinition, für die die Nachricht vorgesehen ist. Dies gilt nur, wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. Wenn dies nicht angegeben wird, gilt die Meldung für alle Richtlinien, die durch diese Richtlinienzuweisung zugewiesen werden.

Override

Der Wert der Richtlinieneigenschaft wird außer Kraft gesetzt.

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

OverrideKind

Die Überschreibungsart.

Name	Typ	Beschreibung
policyEffect	string	Der Richtlinieneffekttyp wird überschrieben.

ParameterValuesValue

Der Wert eines Parameters.

Name	Typ	Beschreibung
value	object	Der Wert des Parameters.