Policy Assignments - Get

Dienst:
Policy
API-Version:
2025-11-01

Diese Operation ruft eine einzelne Richtlinienzuweisung ab, die mit ihrem Namen und dem Umfang angegeben ist, in dem sie erstellt wurde.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2025-11-01
Mit optionalen Parametern: 
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2025-11-01&$expand={$expand}

URI-Parameter

Name In Erforderlich Typ Beschreibung
policyAssignmentName
 path True

string

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

Der Name der abzurufenden Richtlinienzuweisung.
scope
 path True

string

Die vollständig qualifizierte Azure Resource Manager-Kennung der Ressource.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand
 query

string

Komma-getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Unterstützte Werte sind 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

Antworten

Name Typ Beschreibung
200 OK

PolicyAssignment

Azure-Operation erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Retrieve a policy assignment
Retrieve a policy assignment with a system assigned identity
Retrieve a policy assignment with a user assigned identity
Retrieve a policy assignment with overrides
Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

Beispielanforderung

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with a system assigned identity

Beispielanforderung

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with a user assigned identity

Beispielanforderung

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a"
      }
    }
  },
  "location": "westus",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with overrides

Beispielanforderung

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2025-11-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "properties": {
    "description": "Limit the resource location and resource SKU",
    "definitionVersion": "1.*.*",
    "displayName": "Limit the resource location and resource SKU",
    "enforcementMode": "Default",
    "instanceId": "d2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "overrides": [
      {
        "kind": "policyEffect",
        "selectors": [
          {
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ],
            "kind": "policyDefinitionReferenceId"
          }
        ],
        "value": "Audit"
      }
    ],
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with resource selectors

Beispielanforderung

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2025-11-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "properties": {
    "description": "Limit the resource location and resource SKU",
    "definitionVersion": "1.*.*",
    "displayName": "Limit the resource location and resource SKU",
    "enforcementMode": "Default",
    "instanceId": "a3c4d5e6-f7a8-9b0c-1d2e-3f4a5b6c7d8e",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "in": [
              "eastus2euap",
              "centraluseuap"
            ],
            "kind": "resourceLocation"
          }
        ]
      }
    ],
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Definitionen

Name Beschreibung
AssignmentType

Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
EnforcementMode

Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
Identity

Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Das ist entweder eine systemzugewiesene Identität oder eine einzelne Benutzer-zugewiesene Identität.
NonComplianceMessage

Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
Override

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
OverrideKind

Die Überschreibungsart.
ParameterValuesValue

Der Wert eines Parameters.
PolicyAssignment

Die Policenzuweisung.
ResourceIdentityType

Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.
ResourceSelector

Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.
Selector

Der Selektorausdruck.
SelectorKind

Die Selektorart.
SelfServeExemptionSettings

Die Einstellungen für Selbstbedienungsbefreiungen bei einer Police.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentitiesValue

AssignmentType

Enumeration

Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.

Wert Beschreibung
NotSpecified

Der nicht spezifizierte Zuteilungstyp.
System

Der Systemzuweisungstyp.
SystemHidden

Der Systemtyp für versteckte Zuweisungen.
Custom

Der benutzerdefinierte Zuweisungstyp.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

EnforcementMode

Enumeration

Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".

Wert Beschreibung
Default

Die Richtlinienauswirkung wird während der Erstellung oder Aktualisierung von Ressourcen erzwungen.
DoNotEnforce

Der Policy-Effekt wird während der Ressourcenerstellung oder Aktualisierung nicht durchgesetzt.
Enroll

Der Policy-Effekt wird während der Ressourcenerstellung oder Aktualisierung nicht durchgesetzt, bis die Ressource oder der Umfang der Ressource in die Zuweisungsinstanz eingebunden ist. Die Anmeldung erfolgt nach der Bereitstellung der Policy-Enrollment-Ressource.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

Identity

Objekt

Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Das ist entweder eine systemzugewiesene Identität oder eine einzelne Benutzer-zugewiesene Identität.

Name Typ Beschreibung
principalId

string

Die Haupt-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemzugeordnete Identität bereitgestellt
tenantId

string

Die Tenant-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine systemzugeordnete Identität bereitgestellt
type

ResourceIdentityType

Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.
userAssignedIdentities

<string,  UserAssignedIdentitiesValue>

Die Benutzeridentität, die der Richtlinie zugeordnet ist. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Objekt

Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in 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 kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
policyDefinitionReferenceId

string

Die Richtliniendefinitionsreferenz-ID 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 Nachricht für alle Richtlinien, die von dieser Richtlinienzuweisung zugewiesen werden.

Override

Objekt

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.

Name Typ Beschreibung
kind

OverrideKind

Die Überschreibungsart.
selectors

Selector[]

Die Liste der Selektorausdrücke.
value

string

Der Wert, der die Richtlinieneigenschaft außer Kraft setzen soll.

OverrideKind

Enumeration

Die Überschreibungsart.

Wert Beschreibung
policyEffect

Sie überschreibt die Art des Versicherungseffekts.
definitionVersion

Sie überschreibt den Definitionsversionseigenschaftswert der Policy-Zuweisung.

ParameterValuesValue

Objekt

Der Wert eines Parameters.

Name Typ Beschreibung
value

Der Wert des Parameters.

PolicyAssignment

Objekt

Die Policenzuweisung.

Name Typ Standardwert Beschreibung
id

string (arm-id)

Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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 Ressource
properties.assignmentType

AssignmentType

Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.
properties.definitionVersion

string

Die Version der zu verwendenden Richtliniendefinition.
properties.description

string

Diese Nachricht wird teil der Antwort im Falle eines Richtlinienverstoßes sein.
properties.displayName

string

Der Anzeigename der Richtlinienzuweisung.
properties.effectiveDefinitionVersion

string

Die wirksame Version der verwendeten Policendefinition. Dies ist nur vorhanden, wenn es über den $expand Abfrageparameter angefordert wird.
properties.enforcementMode

EnforcementMode

Default

Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".
properties.instanceId

string

Die Instanz-ID der Richtlinienzuweisung. Diese ID ändert sich nur und ändert sich immer, wenn die Zuweisung gelöscht und neu erstellt wird.
properties.latestDefinitionVersion

string

Die neueste Version der Policendefinition ist verfügbar. Dies ist nur vorhanden, wenn es über den $expand Abfrageparameter angefordert wird.
properties.metadata

Die Metadaten der Richtlinienzuweisung. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.nonComplianceMessages

NonComplianceMessage[]

Die Nachrichten, die beschreiben, warum eine Ressource nicht mit der Richtlinie kompatibel ist.
properties.notScopes

string[]

Die ausgeschlossenen Bereiche der Richtlinie.
properties.overrides

Override[]

Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
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.
properties.selfServeExemptionSettings

SelfServeExemptionSettings

Die Einstellungen für Selbstbedienungsbefreiungen für die Policenübertragung.
systemData

systemData

Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ResourceIdentityType

Enumeration

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

Wert Beschreibung
SystemAssigned

Zeigt an, dass eine systemzugeordnete Identität mit der Ressource verknüpft ist.
UserAssigned

Zeigt an, dass eine systemzugeordnete Identität mit der Ressource verknüpft ist.
None

Zeigt an, dass keine Identität mit der Ressource verknüpft ist oder dass die bestehende Identität entfernt werden sollte.

ResourceSelector

Objekt

Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.

Name Typ Beschreibung
name

string

Der Name der Ressourcenauswahl.
selectors

Selector[]

Die Liste der Selektorausdrücke.

Selector

Objekt

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

Enumeration

Die Selektorart.

Wert Beschreibung
resourceLocation

Die Auswahlart zum Filtern von Richtlinien nach dem Ressourcenspeicherort.
resourceType

Die Auswahlart zum Filtern von Richtlinien nach dem Ressourcentyp.
resourceWithoutLocation

Die Auswahlart zum Filtern von Richtlinien nach der Ressource ohne Speicherort.
policyDefinitionReferenceId

Die Auswahlart zum Filtern von Richtlinien nach der Richtliniendefinitionsreferenz-ID.

SelfServeExemptionSettings

Objekt

Die Einstellungen für Selbstbedienungsbefreiungen bei einer Police.

Name Typ Beschreibung
enabled

boolean

Gibt an, ob eine Selbstbedienungsbefreiung aktiviert ist.
policyDefinitionReferenceIds

string[]

Die Richtliniendefinition bezieht sich auf IDs für Self-Service-Ausnahmen.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

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 (date-time)

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.

UserAssignedIdentitiesValue

Objekt
Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.