Policy Events - List Query Results For Resource Group

Služba:: Policy

Verze rozhraní API:: 2024-10-01

Dotazuje události zásad pro prostředky v rámci skupiny prostředků.

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

S volitelnými parametry:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
policyEventsResource	path	True	PolicyEventsResourceType	Název virtuálního prostředku pod typem prostředku PolicyEvents; Je povolená pouze výchozí hodnota.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Microsoft Azure subscription ID.
api-version	query	True	string	Verze rozhraní API klienta.
$apply	query		string	Použití výrazu OData pro agregace
$filter	query		string	Výraz filtru OData
$from	query		string (date-time)	Časové razítko ve formátu ISO 8601 určující počáteční čas intervalu pro dotaz. Pokud není zadáno, služba používá ($to – 1 den).
$orderby	query		string	Uspořádání výrazu pomocí notace OData. Jeden nebo více názvů sloupců oddělených čárkami s volitelným "desc" (výchozí) nebo "asc", například "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Výběr výrazu pomocí zápisu OData Omezí sloupce jednotlivých záznamů jenom na požadované sloupce, například "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken se poskytuje pouze v případě, že předchozí odpověď vrátila částečný výsledek jako součást elementu nextLink.
$to	query		string (date-time)	Časové razítko ve formátu ISO 8601 určující koncový čas intervalu, který se má dotazovat. Pokud není zadáno, služba používá čas požadavku.
$top	query		integer (int32) minimum: 0	Maximální počet záznamů, které se mají vrátit.

Odpovědi

Name	Typ	Description
200 OK	PolicyEventsQueryResults	Výsledky dotazu
Other Status Codes	QueryFailure	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Query at resource group scope

Query at resource group scope with next link

Query at resource group scope

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-07T20:43:04.6971328Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.ServiceFabric/clusters/applications",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "ec62f9b2a454487296f2ccd4",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}",
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
      "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": "181565554491747128",
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-07T20:43:04.6971328Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.ServiceFabric/clusters/applications",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "ec62f9b2a454487296f2ccd4",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}",
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
      "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": "624540685646900425",
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6",
      "complianceState": "NonCompliant"
    }
  ]
}

Query at resource group scope with next link

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-07T20:43:04.6971328Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.ServiceFabric/clusters/applications",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "ec62f9b2a454487296f2ccd4",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}",
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
      "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": "181565554491747128",
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-07T20:43:04.6971328Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.ServiceFabric/clusters/applications",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "ec62f9b2a454487296f2ccd4",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}",
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
      "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": "624540685646900425",
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6",
      "complianceState": "NonCompliant"
    }
  ]
}

Definice

Name	Description
ComponentEventDetails	Podrobnosti události komponenty.
Error	Definice chyby
PolicyEvent	Záznam události zásad.
PolicyEventsQueryResults	Výsledky dotazu
PolicyEventsResourceType	Název virtuálního prostředku pod typem prostředku PolicyEvents; Je povolená pouze výchozí hodnota.
QueryFailure	Chybová odpověď.

ComponentEventDetails

Objekt

Podrobnosti události komponenty.

Name	Typ	Description
id	string	ID součásti.
name	string	Název komponenty.
policyDefinitionAction	string	Akce definice zásady, tj. účinek.
principalOid	string	ID objektu objektu objektu objektu objektu uživatele, který inicioval operaci komponenty prostředku, která aktivovala událost zásad.
tenantId	string	ID tenanta pro záznam události zásady.
timestamp	string (date-time)	Časové razítko pro záznam události zásad komponent
type	string	Typ komponenty.

Error

Objekt

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav kódu chyby HTTP.
message	string	Popis chyby

PolicyEvent

Objekt

Záznam události zásad.

Name	Typ	Description
@odata.context	string	Kontextový řetězec OData; klienti OData používají k překladu informací o typech na základě metadat.
@odata.id	string	ID entity OData; vždy nastavena na hodnotu null, protože záznamy událostí zásad nemají ID entity.
complianceState	string	Stav dodržování předpisů prostředku
components	ComponentEventDetails[]	Události komponent se zaznamenávají pouze v případech, kdy adresa URL obsahuje klauzuli $expand=components.
effectiveParameters	string	Platné parametry pro přiřazení zásad.
isCompliant	boolean	Označte příznakem, který uvádí, jestli prostředek vyhovuje přiřazení zásady, vůči kterému byl vyhodnocen.
managementGroupIds	string	Čárkami oddělený seznam ID skupin pro správu, které představují hierarchii skupin pro správu, pod kterými se prostředek nachází.
policyAssignmentId	string	ID přiřazení zásad.
policyAssignmentName	string	Název přiřazení zásad
policyAssignmentOwner	string	Vlastník přiřazení zásad
policyAssignmentParameters	string	Parametry přiřazení zásad
policyAssignmentScope	string	Rozsah přiřazení zásad
policyDefinitionAction	string	Akce definice zásady, tj. účinek.
policyDefinitionCategory	string	Kategorie definice zásad.
policyDefinitionId	string	ID definice zásady.
policyDefinitionName	string	Název definice zásady.
policyDefinitionReferenceId	string	Referenční ID definice zásady uvnitř sady zásad, pokud je přiřazení zásady pro sadu zásad.
policySetDefinitionCategory	string	Kategorie definice sady zásad, pokud je přiřazení zásady pro sadu zásad.
policySetDefinitionId	string	ID definice sady zásad, pokud je přiřazení zásady pro sadu zásad.
policySetDefinitionName	string	Název definice sady zásad, pokud je přiřazení zásady pro sadu zásad.
policySetDefinitionOwner	string	Vlastník definice sady zásad, pokud je přiřazení zásady pro sadu zásad.
policySetDefinitionParameters	string	Parametry definice sady zásad, pokud je přiřazení zásady pro sadu zásad.
principalOid	string	ID objektu objektu uživatele, který inicioval operaci prostředku, která aktivovala událost zásad.
resourceGroup	string	Název skupiny prostředků.
resourceId	string	ID prostředku.
resourceLocation	string	Umístění prostředku
resourceTags	string	Seznam značek prostředků
resourceType	string	Typ zdroje.
subscriptionId	string	ID předplatného.
tenantId	string	ID tenanta pro záznam události zásady.
timestamp	string (date-time)	Časové razítko záznamu události zásady

PolicyEventsQueryResults

Objekt

Výsledky dotazu

Name	Typ	Description
@odata.context	string	Kontextový řetězec OData; klienti OData používají k překladu informací o typech na základě metadat.
@odata.count	integer (int32) minimum: 0	Počet entit OData; představuje počet vrácených záznamů událostí zásad.
@odata.nextLink	string	Další odkaz Odata; Adresa URL pro získání další sady výsledků
value	PolicyEvent[]	Výsledky dotazu

PolicyEventsResourceType

Výčet

Název virtuálního prostředku pod typem prostředku PolicyEvents; Je povolená pouze výchozí hodnota.

Hodnota	Description
default

QueryFailure

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Definice chyby

Sdílet prostřednictvím

Policy Events - List Query Results For Resource Group

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Query at resource group scope

Ukázkový požadavek

Ukázková odpověď

Query at resource group scope with next link

Ukázkový požadavek

Ukázková odpověď

Definice

ComponentEventDetails

Error

PolicyEvent

PolicyEventsQueryResults

PolicyEventsResourceType

QueryFailure