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

Service:: Policy

API-versie:: 2024-10-01

Query's uitvoeren op beleidsevenementen voor de beleidstoewijzing op resourcegroepsniveau.

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
authorizationNamespace	path	True	AuthorizationNamespaceType	De naamruimte voor de resourceprovider microsoft-autorisatie; alleen 'Microsoft.Authorization' is toegestaan.
policyAssignmentName	path	True	string	Naam van beleidstoewijzing.
policyEventsResource	path	True	PolicyEventsResourceType	De naam van de virtuele resource onder PolicyEvents-resourcetype; alleen 'standaard' is toegestaan.
resourceGroupName	path	True	string	Naam van de resourcegroep.
subscriptionId	path	True	string	Microsoft Azure abonnements-ID.
api-version	query	True	string	Client-API-versie.
$apply	query		string	OData past expressies toe voor aggregaties.
$filter	query		string	OData-filterexpressie.
$from	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de begintijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service ($to - 1 dag).
$orderby	query		string	Expressie ordenen met behulp van OData-notatie. Een of meer door komma's gescheiden kolomnamen met een optionele 'desc' (de standaardinstelling) of 'asc', bijvoorbeeld '$orderby=PolicyAssignmentId, ResourceId asc'.
$select	query		string	Expressie selecteren met behulp van OData-notatie. Beperkt de kolommen voor elke record tot alleen de aangevraagde records, bijvoorbeeld '$select=PolicyAssignmentId, ResourceId'.
$skiptoken	query		string	Skiptoken wordt alleen opgegeven als een eerder antwoord een gedeeltelijk resultaat heeft geretourneerd als onderdeel van het nextLink-element.
$to	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de eindtijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service de aanvraagtijd.
$top	query		integer (int32) minimum: 0	Maximum aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	PolicyEventsQueryResults	Queryresultaten.
Other Status Codes	QueryFailure	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AuthorizationNamespaceType	De naamruimte voor de resourceprovider microsoft-autorisatie; alleen 'Microsoft.Authorization' is toegestaan.
ComponentEventDetails	Details van onderdeelevenementen.
Error	Foutdefinitie.
PolicyEvent	Record voor beleidsevenementen.
PolicyEventsQueryResults	Queryresultaten.
PolicyEventsResourceType	De naam van de virtuele resource onder PolicyEvents-resourcetype; alleen 'standaard' is toegestaan.
QueryFailure	Foutreactie.

AuthorizationNamespaceType

Opsomming

De naamruimte voor de resourceprovider microsoft-autorisatie; alleen 'Microsoft.Authorization' is toegestaan.

Waarde	Description
Microsoft.Authorization

ComponentEventDetails

Object

Details van onderdeelevenementen.

Name	Type	Description
id	string	Onderdeel-id.
name	string	Onderdeelnaam.
policyDefinitionAction	string	Actie voor beleidsdefinitie, bijvoorbeeld effect.
principalOid	string	Principal-object-id voor de gebruiker die de bewerking resourceonderdeel heeft gestart die de beleidsgebeurtenis heeft geactiveerd.
tenantId	string	Tenant-id voor de record van de beleids gebeurtenis.
timestamp	string (date-time)	Tijdstempel voor gebeurtenisrecord voor onderdeelbeleid.
type	string	Onderdeeltype.

Error

Object

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
message	string	Beschrijving van de fout.

PolicyEvent

Object

Record voor beleidsevenementen.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.id	string	OData-entiteits-id; altijd ingesteld op null omdat records voor beleidsevenementen geen entiteits-id hebben.
complianceState	string	Nalevingsstatus van de resource.
components	ComponentEventDetails[]	Onderdelengebeurtenissen worden alleen ingevuld wanneer de URL $expand=component onderdelen bevat.
effectiveParameters	string	Effectieve parameters voor de beleidstoewijzing.
isCompliant	boolean	Vlag die aangeeft of de resource compatibel is met de beleidstoewijzing waarop deze is geëvalueerd.
managementGroupIds	string	Door komma's gescheiden lijst met beheergroep-id's, die de hiërarchie van de beheergroepen vertegenwoordigen waaronder de resource zich bevindt.
policyAssignmentId	string	Id van beleidstoewijzing.
policyAssignmentName	string	Naam van beleidstoewijzing.
policyAssignmentOwner	string	Eigenaar van beleidstoewijzing.
policyAssignmentParameters	string	Beleidstoewijzingsparameters.
policyAssignmentScope	string	Bereik van beleidstoewijzing.
policyDefinitionAction	string	Actie voor beleidsdefinitie, bijvoorbeeld effect.
policyDefinitionCategory	string	Categorie beleidsdefinitie.
policyDefinitionId	string	Id van beleidsdefinitie.
policyDefinitionName	string	Naam van beleidsdefinitie.
policyDefinitionReferenceId	string	Referentie-id voor de beleidsdefinitie in de beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionCategory	string	Definitiecategorie van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionId	string	Definitie-id van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionName	string	Naam van beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionOwner	string	Eigenaar van beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionParameters	string	Definitieparameters voor beleidssets als de beleidstoewijzing voor een beleidsset is.
principalOid	string	Principal-object-id voor de gebruiker die de resourcebewerking heeft gestart die de beleidsgebeurtenis heeft geactiveerd.
resourceGroup	string	Naam van de resourcegroep.
resourceId	string	Resource-id.
resourceLocation	string	Resourcelocatie.
resourceTags	string	Lijst met resourcetags.
resourceType	string	Type bron
subscriptionId	string	Abonnements-id.
tenantId	string	Tenant-id voor de record van de beleids gebeurtenis.
timestamp	string (date-time)	Tijdstempel voor de record van de beleids gebeurtenis.

PolicyEventsQueryResults

Object

Queryresultaten.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.count	integer (int32) minimum: 0	Aantal OData-entiteiten; vertegenwoordigt het aantal geretourneerde beleidsgebeurtenisrecords.
@odata.nextLink	string	Odata next link; URL voor het ophalen van de volgende set resultaten.
value	PolicyEvent[]	Queryresultaten.

PolicyEventsResourceType

Opsomming

De naam van de virtuele resource onder PolicyEvents-resourcetype; alleen 'standaard' is toegestaan.

Waarde	Description
default

QueryFailure

Object

Foutreactie.

Name	Type	Description
error	Error	Foutdefinitie.

Delen via

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

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Query at resource group level policy assignment scope

Voorbeeldaanvraag

Voorbeeldrespons

Query at resource group level policy assignment scope with next link

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AuthorizationNamespaceType

ComponentEventDetails

Error

PolicyEvent

PolicyEventsQueryResults

PolicyEventsResourceType

QueryFailure