Policy Events - List Query Results For Resource Group Level Policy Assignment
Wysyła zapytania dotyczące zdarzeń zasad dla przypisania zasad na poziomie grupy zasobów.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2019-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
authorization
|
path | True |
Przestrzeń nazw dostawcy zasobów autoryzacji firmy Microsoft; dozwolony jest tylko element "Microsoft.Authorization". |
|
policy
|
path | True |
string |
Nazwa przypisania zasad. |
policy
|
path | True |
Nazwa zasobu wirtualnego w obszarze PolicyEvents typ zasobu; dozwolone jest tylko ustawienie "domyślne". |
|
resource
|
path | True |
string |
Nazwa grupy zasobów. |
subscription
|
path | True |
string |
Identyfikator subskrypcji platformy Microsoft Azure. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
$apply
|
query |
string |
Wyrażenie zastosuj OData dla agregacji. |
|
$filter
|
query |
string |
Wyrażenie filtru OData. |
|
$from
|
query |
string date-time |
Formatowany znacznik czasu ISO 8601 określający godzinę rozpoczęcia interwału zapytania. Jeśli nie zostanie określona, usługa używa ($to - 1-dniowy). |
|
$orderby
|
query |
string |
Porządkowanie wyrażenia przy użyciu notacji OData. Co najmniej jedna nazwa kolumn rozdzielanych przecinkami z opcjonalnym ciągiem "desc" (wartość domyślna) lub "asc", np. "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Wybierz wyrażenie przy użyciu notacji OData. Ogranicza kolumny dla każdego rekordu tylko do żądanych, np. "$select=PolicyAssignmentId, ResourceId". |
|
$skiptoken
|
query |
string |
Skiptoken jest dostarczany tylko wtedy, gdy poprzednia odpowiedź zwróciła częściowy wynik w ramach elementu nextLink. |
|
$to
|
query |
string date-time |
Sformatowany znacznik czasu ISO 8601 określający czas zakończenia interwału zapytania. Jeśli nie zostanie określony, usługa używa czasu żądania. |
|
$top
|
query |
integer int32 |
Maksymalna liczba rekordów do zwrócenia. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Wyniki zapytania. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
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
Przykładowe żądanie
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=2019-10-01
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD
Przykładowa odpowiedź
{
"@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"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Authorization |
Przestrzeń nazw dostawcy zasobów autoryzacji firmy Microsoft; dozwolony jest tylko element "Microsoft.Authorization". |
Component |
Szczegóły zdarzenia składnika. |
Error |
Definicja błędu. |
Policy |
Rekord zdarzenia zasad. |
Policy |
Wyniki zapytania. |
Policy |
Nazwa zasobu wirtualnego w obszarze PolicyEvents typ zasobu; dozwolone jest tylko ustawienie "domyślne". |
Query |
Odpowiedź na błąd. |
AuthorizationNamespaceType
Przestrzeń nazw dostawcy zasobów autoryzacji firmy Microsoft; dozwolony jest tylko element "Microsoft.Authorization".
Nazwa | Typ | Opis |
---|---|---|
Microsoft.Authorization |
string |
ComponentEventDetails
Szczegóły zdarzenia składnika.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator składnika. |
name |
string |
Nazwa składnika. |
policyDefinitionAction |
string |
Akcja definicji zasad, tj. efekt. |
principalOid |
string |
Identyfikator obiektu podmiotu zabezpieczeń dla użytkownika, który zainicjował operację składnika zasobu, która wyzwoliła zdarzenie zasad. |
tenantId |
string |
Identyfikator dzierżawy dla rekordu zdarzenia zasad. |
timestamp |
string |
Sygnatura czasowa rekordu zdarzeń zasad składników. |
type |
string |
Typ składnika. |
Error
Definicja błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP. |
message |
string |
Opis błędu. |
PolicyEvent
Rekord zdarzenia zasad.
Nazwa | Typ | Opis |
---|---|---|
@odata.context |
string |
Ciąg kontekstu OData; używane przez klientów OData do rozpoznawania informacji o typie na podstawie metadanych. |
@odata.id |
string |
Identyfikator jednostki OData; ustawienie zawsze ma wartość null, ponieważ rekordy zdarzeń zasad nie mają identyfikatora jednostki. |
complianceState |
string |
Stan zgodności zasobu. |
components |
Zdarzenia składników są wypełniane tylko wtedy, gdy adres URL zawiera klauzulę $expand=components. |
|
effectiveParameters |
string |
Obowiązujące parametry przypisania zasad. |
isCompliant |
boolean |
Flaga, która wskazuje, czy zasób jest zgodny z przypisaniem zasad, względem którego został oceniony. |
managementGroupIds |
string |
Rozdzielona przecinkami lista identyfikatorów grup zarządzania, które reprezentują hierarchię grup zarządzania, w których znajduje się zasób. |
policyAssignmentId |
string |
Identyfikator przypisania zasad. |
policyAssignmentName |
string |
Nazwa przypisania zasad. |
policyAssignmentOwner |
string |
Właściciel przypisania zasad. |
policyAssignmentParameters |
string |
Parametry przypisania zasad. |
policyAssignmentScope |
string |
Zakres przypisania zasad. |
policyDefinitionAction |
string |
Akcja definicji zasad, tj. efekt. |
policyDefinitionCategory |
string |
Kategoria definicji zasad. |
policyDefinitionId |
string |
Identyfikator definicji zasad. |
policyDefinitionName |
string |
Nazwa definicji zasad. |
policyDefinitionReferenceId |
string |
Identyfikator odwołania dla definicji zasad w zestawie zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
policySetDefinitionCategory |
string |
Kategoria definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
policySetDefinitionId |
string |
Identyfikator definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
policySetDefinitionName |
string |
Nazwa definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
policySetDefinitionOwner |
string |
Właściciel definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
policySetDefinitionParameters |
string |
Parametry definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad. |
principalOid |
string |
Identyfikator obiektu podmiotu zabezpieczeń dla użytkownika, który zainicjował operację zasobu, która wyzwoliła zdarzenie zasad. |
resourceGroup |
string |
Nazwa grupy zasobów. |
resourceId |
string |
Identyfikator zasobu. |
resourceLocation |
string |
Lokalizacja zasobu. |
resourceTags |
string |
Lista tagów zasobów. |
resourceType |
string |
Typ zasobu. |
subscriptionId |
string |
Identyfikator subskrypcji. |
tenantId |
string |
Identyfikator dzierżawy dla rekordu zdarzenia zasad. |
timestamp |
string |
Sygnatura czasowa rekordu zdarzenia zasad. |
PolicyEventsQueryResults
Wyniki zapytania.
Nazwa | Typ | Opis |
---|---|---|
@odata.context |
string |
Ciąg kontekstu OData; używane przez klientów OData do rozpoznawania informacji o typie na podstawie metadanych. |
@odata.count |
integer |
Liczba jednostek OData; reprezentuje liczbę zwracanych rekordów zdarzeń zasad. |
@odata.nextLink |
string |
Odata następny link; Adres URL umożliwiający uzyskanie następnego zestawu wyników. |
value |
Wyniki zapytania. |
PolicyEventsResourceType
Nazwa zasobu wirtualnego w obszarze PolicyEvents typ zasobu; dozwolone jest tylko ustawienie "domyślne".
Nazwa | Typ | Opis |
---|---|---|
default |
string |
QueryFailure
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Definicja błędu. |