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

Tjänst:: Policy

API-version:: 2024-10-01

Kör frågor mot principhändelser för principtilldelningen på resursgruppsnivå.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
authorizationNamespace	path	True	AuthorizationNamespaceType	Namnområdet för Microsoft Authorization-resursprovidern; endast "Microsoft.Authorization" tillåts.
policyAssignmentName	path	True	string	Namn på principtilldelning.
policyEventsResource	path	True	PolicyEventsResourceType	Namnet på den virtuella resursen under PrincipHändelseresurstyp. endast "standard" tillåts.
resourceGroupName	path	True	string	Namn på resursgrupp.
subscriptionId	path	True	string	Microsoft Azure prenumerations-ID.
api-version	query	True	string	Klient-API-version.
$apply	query		string	OData tillämpar uttryck för sammansättningar.
$filter	query		string	OData-filteruttryck.
$from	query		string (date-time)	ISO 8601-formaterad tidsstämpel som anger starttiden för intervallet som ska frågas. När det inte anges använder tjänsten ($to – 1 dag).
$orderby	query		string	Orderuttryck med OData-notation. Ett eller flera kommaavgränsade kolumnnamn med ett valfritt "desc" (standard) eller "asc", t.ex. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Välj uttryck med OData-notation. Begränsar kolumnerna för varje post till bara de begärda, t.ex. "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken tillhandahålls endast om ett tidigare svar returnerade ett partiellt resultat som en del av nextLink-elementet.
$to	query		string (date-time)	ISO 8601-formaterad tidsstämpel som anger sluttiden för intervallet som ska frågas. När det inte anges använder tjänsten begärandetiden.
$top	query		integer (int32) minimum: 0	Maximalt antal poster som ska returneras.

Svar

Name	Typ	Description
200 OK	PolicyEventsQueryResults	Frågeresultat.
Other Status Codes	QueryFailure	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
    }
  ]
}

Definitioner

Name	Description
AuthorizationNamespaceType	Namnområdet för Microsoft Authorization-resursprovidern; endast "Microsoft.Authorization" tillåts.
ComponentEventDetails	Information om komponenthändelsen.
Error	Feldefinition.
PolicyEvent	Principhändelsepost.
PolicyEventsQueryResults	Frågeresultat.
PolicyEventsResourceType	Namnet på den virtuella resursen under PrincipHändelseresurstyp. endast "standard" tillåts.
QueryFailure	Felsvar.

AuthorizationNamespaceType

Uppräkning

Namnområdet för Microsoft Authorization-resursprovidern; endast "Microsoft.Authorization" tillåts.

Värde	Description
Microsoft.Authorization

ComponentEventDetails

Objekt

Information om komponenthändelsen.

Name	Typ	Description
id	string	Komponent-ID.
name	string	Komponentnamn.
policyDefinitionAction	string	Principdefinitionsåtgärd, d.v.s. effekt.
principalOid	string	Huvudobjekt-ID för den användare som initierade resurskomponentåtgärden som utlöste principhändelsen.
tenantId	string	Klientorganisations-ID för principhändelseposten.
timestamp	string (date-time)	Tidsstämpel för händelsepost för komponentprincip.
type	string	Komponenttyp.

Error

Objekt

Feldefinition.

Name	Typ	Description
code	string	Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.
message	string	Beskrivning av felet.

PolicyEvent

Objekt

Principhändelsepost.

Name	Typ	Description
@odata.context	string	OData-kontextsträng; används av OData-klienter för att matcha typinformation baserat på metadata.
@odata.id	string	OData-entitets-ID; är alltid inställt på null eftersom principhändelseposter inte har något entitets-ID.
complianceState	string	Resursens efterlevnadstillstånd.
components	ComponentEventDetails[]	Händelseposter för komponenter fylls endast i när URL:en innehåller $expand=components-sats.
effectiveParameters	string	Effektiva parametrar för principtilldelningen.
isCompliant	boolean	Flagga som anger om resursen är kompatibel med den principtilldelning som den utvärderades mot.
managementGroupIds	string	Kommaavgränsad lista över hanteringsgrupps-ID:t, som representerar hierarkin för de hanteringsgrupper som resursen finns under.
policyAssignmentId	string	Principtilldelnings-ID.
policyAssignmentName	string	Namn på principtilldelning.
policyAssignmentOwner	string	Principtilldelningsägare.
policyAssignmentParameters	string	Principtilldelningsparametrar.
policyAssignmentScope	string	Principtilldelningsomfång.
policyDefinitionAction	string	Principdefinitionsåtgärd, d.v.s. effekt.
policyDefinitionCategory	string	Principdefinitionskategori.
policyDefinitionId	string	Principdefinitions-ID.
policyDefinitionName	string	Namn på principdefinition.
policyDefinitionReferenceId	string	Referens-ID för principdefinitionen i principuppsättningen, om principtilldelningen är för en principuppsättning.
policySetDefinitionCategory	string	Definitionskategori för principuppsättning, om principtilldelningen är för en principuppsättning.
policySetDefinitionId	string	Principuppsättningsdefinitions-ID, om principtilldelningen är för en principuppsättning.
policySetDefinitionName	string	Definitionsnamn för principuppsättning, om principtilldelningen är för en principuppsättning.
policySetDefinitionOwner	string	Principuppsättningens definitionsägare, om principtilldelningen är för en principuppsättning.
policySetDefinitionParameters	string	Definitionsparametrar för principuppsättningar, om principtilldelningen är för en principuppsättning.
principalOid	string	Huvudobjekt-ID för den användare som initierade resursåtgärden som utlöste principhändelsen.
resourceGroup	string	Namn på resursgrupp.
resourceId	string	Resurs-ID.
resourceLocation	string	Resursplats.
resourceTags	string	Lista över resurstaggar.
resourceType	string	Resurstyp.
subscriptionId	string	Prenumerations-ID.
tenantId	string	Klientorganisations-ID för principhändelseposten.
timestamp	string (date-time)	Tidsstämpel för principhändelseposten.

PolicyEventsQueryResults

Objekt

Frågeresultat.

Name	Typ	Description
@odata.context	string	OData-kontextsträng; används av OData-klienter för att matcha typinformation baserat på metadata.
@odata.count	integer (int32) minimum: 0	Antal OData-entiteter. representerar antalet principhändelseposter som returneras.
@odata.nextLink	string	Odata nästa länk; URL för att hämta nästa uppsättning resultat.
value	PolicyEvent[]	Frågeresultat.

PolicyEventsResourceType

Uppräkning

Namnet på den virtuella resursen under PrincipHändelseresurstyp. endast "standard" tillåts.

Värde	Description
default

QueryFailure

Objekt

Felsvar.

Name	Typ	Description
error	Error	Feldefinition.

Dela via

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

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Query at resource group level policy assignment scope

Exempelbegäran

Exempelsvar

Query at resource group level policy assignment scope with next link

Exempelbegäran

Exempelsvar

Definitioner

AuthorizationNamespaceType

ComponentEventDetails

Error

PolicyEvent

PolicyEventsQueryResults

PolicyEventsResourceType

QueryFailure