Policy Events - List Query Results For Resource Group Level Policy Assignment

Dienst:: Policy

API-Version:: 2024-10-01

Fragt Richtlinienereignisse für die Richtlinienzuweisung auf Ressourcengruppenebene ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01

Mit optionalen Parametern:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationNamespace	path	True	AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
policyAssignmentName	path	True	string	Name der Richtlinienzuweisung.
policyEventsResource	path	True	PolicyEventsResourceType	Der Name der virtuellen Ressource unter dem Ressourcentyp "PolicyEvents"; nur "Standard" ist zulässig.
resourceGroupName	path	True	string	Ressourcengruppenname.
subscriptionId	path	True	string	Microsoft Azure Subscription ID.
api-version	query	True	string	Client-API-Version.
$apply	query		string	OData wendet einen Ausdruck für Aggregationen an.
$filter	query		string	OData-Filterausdruck.
$from	query		string (date-time)	Iso 8601 formatierter Zeitstempel, der die Startzeit des abfrageintervalls angibt. Wenn nicht angegeben, verwendet der Dienst ($to - 1 Tag).
$orderby	query		string	Sortierungsausdruck mithilfe der OData-Schreibweise. Ein oder mehrere durch Trennzeichen getrennte Spaltennamen mit einem optionalen "desc" (Standard) oder "asc", z. B. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Wählen Sie einen Ausdruck mit der OData-Schreibweise aus. Beschränkt die Spalten für jeden Datensatz auf die angeforderten Datensätze, z. B. "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken wird nur bereitgestellt, wenn eine vorherige Antwort ein Teilergebnis als Teil des nextLink-Elements zurückgegeben hat.
$to	query		string (date-time)	ISO 8601-formatierter Zeitstempel, der die Endzeit des abzufragenden Intervalls angibt. Wenn nicht angegeben, verwendet der Dienst die Anforderungszeit.
$top	query		integer (int32) minimum: 0	Maximale Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyEventsQueryResults	Abfrageergebnisse.
Other Status Codes	QueryFailure	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Query at resource group level policy assignment scope

Query at resource group level policy assignment scope with next link

Query at resource group level policy assignment scope

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:07:16.2804863Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:06:08.4302267Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    }
  ]
}

Query at resource group level policy assignment scope with next link

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01&$skiptoken=WpmWfBSvPhkAK6QD

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:07:16.2804863Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:06:08.4302267Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    }
  ]
}

Definitionen

Name	Beschreibung
AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
ComponentEventDetails	Komponentenereignisdetails.
Error	Fehlerdefinition.
PolicyEvent	Richtlinienereignisdatensatz.
PolicyEventsQueryResults	Abfrageergebnisse.
PolicyEventsResourceType	Der Name der virtuellen Ressource unter dem Ressourcentyp "PolicyEvents"; nur "Standard" ist zulässig.
QueryFailure	Fehlerantwort.

AuthorizationNamespaceType

Enumeration

Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.

Wert	Beschreibung
Microsoft.Authorization

ComponentEventDetails

Objekt

Komponentenereignisdetails.

Name	Typ	Beschreibung
id	string	Komponenten-ID.
name	string	Komponentenname.
policyDefinitionAction	string	Richtliniendefinitionsaktion, d. h. Effekt.
principalOid	string	Prinzipalobjekt-ID für den Benutzer, der den Ressourcenkomponentenvorgang initiiert hat, der das Richtlinienereignis ausgelöst hat.
tenantId	string	Mandanten-ID für den Richtlinienereignisdatensatz.
timestamp	string (date-time)	Zeitstempel für Komponentenrichtlinienereignisdatensatz.
type	string	Komponententyp.

Error

Objekt

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
message	string	Beschreibung des Fehlers.

PolicyEvent

Objekt

Richtlinienereignisdatensatz.

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.id	string	OData-Entitäts-ID; Immer auf NULL festgelegt, da Richtlinienereignisdatensätze keine Entitäts-ID aufweisen.
complianceState	string	Compliancestatus der Ressource.
components	ComponentEventDetails[]	Komponentenereignisse werden nur aufgefüllt, wenn die URL $expand=components-Klausel enthält.
effectiveParameters	string	Effektive Parameter für die Richtlinienzuweisung.
isCompliant	boolean	Flag, das angibt, ob die Ressource mit der Richtlinienzuordnung kompatibel ist, für die sie ausgewertet wurde.
managementGroupIds	string	Durch Trennzeichen getrennte Liste der Verwaltungsgruppen-IDs, die die Hierarchie der Verwaltungsgruppen darstellen, unter denen die Ressource steht.
policyAssignmentId	string	Richtlinienzuweisungs-ID.
policyAssignmentName	string	Name der Richtlinienzuweisung.
policyAssignmentOwner	string	Besitzer der Richtlinienzuweisung.
policyAssignmentParameters	string	Richtlinienzuweisungsparameter.
policyAssignmentScope	string	Richtlinienzuweisungsbereich.
policyDefinitionAction	string	Richtliniendefinitionsaktion, d. h. Effekt.
policyDefinitionCategory	string	Richtliniendefinitionskategorie.
policyDefinitionId	string	Richtliniendefinitions-ID.
policyDefinitionName	string	Richtliniendefinitionsname.
policyDefinitionReferenceId	string	Referenz-ID für die Richtliniendefinition innerhalb des Richtliniensatzes, wenn die Richtlinienzuweisung für einen Richtliniensatz vorgesehen ist.
policySetDefinitionCategory	string	Richtliniensatzdefinitionskategorie, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt.
policySetDefinitionId	string	Richtliniensatzdefinitions-ID, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt.
policySetDefinitionName	string	Richtliniensatzdefinitionsname, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt.
policySetDefinitionOwner	string	Richtliniensatzdefinitionsbesitzer, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt.
policySetDefinitionParameters	string	Richtliniensatzdefinitionsparameter, wenn die Richtlinienzuweisung für einen Richtliniensatz vorgesehen ist.
principalOid	string	Prinzipalobjekt-ID für den Benutzer, der den Ressourcenvorgang initiiert hat, der das Richtlinienereignis ausgelöst hat.
resourceGroup	string	Ressourcengruppenname.
resourceId	string	Ressourcen-ID.
resourceLocation	string	Ressourcenspeicherort.
resourceTags	string	Liste der Ressourcentags.
resourceType	string	Ressourcentyp.
subscriptionId	string	Abonnement-ID.
tenantId	string	Mandanten-ID für den Richtlinienereignisdatensatz.
timestamp	string (date-time)	Zeitstempel für den Richtlinienereignisdatensatz.

PolicyEventsQueryResults

Objekt

Abfrageergebnisse.

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.count	integer (int32) minimum: 0	OData-Entitätsanzahl; stellt die Anzahl der zurückgegebenen Richtlinienereignisdatensätze dar.
@odata.nextLink	string	Nächster Link zu Odata; URL, um den nächsten Satz von Ergebnissen abzurufen.
value	PolicyEvent[]	Abfrageergebnisse.

PolicyEventsResourceType

Enumeration

Der Name der virtuellen Ressource unter dem Ressourcentyp "PolicyEvents"; nur "Standard" ist zulässig.

Wert	Beschreibung
default

QueryFailure

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlerdefinition.

Freigeben über

Policy Events - List Query Results For Resource Group Level Policy Assignment

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Query at resource group level policy assignment scope

Beispielanforderung

Beispiel für eine Antwort

Query at resource group level policy assignment scope with next link

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AuthorizationNamespaceType

ComponentEventDetails

Error

PolicyEvent

PolicyEventsQueryResults

PolicyEventsResourceType

QueryFailure