Policy Assignments - List

Referenz

Dienst:: 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, die mit dem optionalen angegebenen $filter übereinstimmen. Gültige Werte für $filter sind: 'atScope()', 'atExactScope()' oder 'policyDefinitionId eq '{value}'. Wenn $filter nicht bereitgestellt wird, enthält die nicht gefilterte Liste alle dem Abonnement zugeordneten Richtlinienzuweisungen, einschließlich derJenigen, die direkt oder von Verwaltungsgruppen gelten, die das angegebene Abonnement enthalten, sowie alle angewendeten Objekte, die im Abonnement enthalten sind. Wenn $filter=atScope() angegeben wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen, die für das Abonnement gelten. Dies ist alles in der nicht gefilterten Liste, mit Ausnahme derjenigen, die auf Objekte im Abonnement angewendet wurden. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen, die im Abonnement vorhanden sind. Wenn $filter=policyDefinitionId eq '{value}' bereitgestellt 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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Durch Trennzeichen getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Unterstützte Werte sind "LatestDefinitionVersion, EffectiveDefinitionVersion".
$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 angegeben wird, wird keine Filterung ausgefü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 nicht gefilterten Liste, mit Ausnahme derjenigen, die auf Unterbereiche im angegebenen Bereich angewendet wurden. Wenn $filter=atExactScope() bereitgestellt wird, enthält die zurückgegebene Liste nur alle Richtlinienzuweisungen, die im angegebenen Bereich vorhanden sind. Wenn $filter=policyDefinitionId eq '{value}' bereitgestellt wird, enthält die zurückgegebene Liste alle Richtlinienzuweisungen der Richtliniendefinition, deren ID {value} lautet.
$top	query		integer int32	Maximale Anzahl der zurückzugebenden Datensätze. Wenn der $top Filter nicht angegeben wird, gibt er 500 Datensätze zurück.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyAssignmentListResult	OK : Gibt ein Array von Richtlinienzuweisungen zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List policy assignments that apply to a subscription

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "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",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "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 Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default und DoNotEnforce.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine vom System zugewiesene 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 Richtlinienzuweisung.
PolicyAssignmentListResult	Liste der Richtlinienzuweisungen.
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.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentities	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}".

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (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 Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default und DoNotEnforce.

Name	Typ	Beschreibung
Default	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung erzwungen.
DoNotEnforce	string	Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung nicht erzwungen.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
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 vom System zugewiesene Identität oder eine einzelne benutzer zugewiesene Identität.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der Ressourcenidentität. Diese Eigenschaft wird nur für eine vom System zugewiesene 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	UserAssignedIdentities	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

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

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

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.