Policy Events - List Query Results For Resource Group Level Policy Assignment
Consulta eventos de política para a atribuição de políticas ao nível do grupo de recursos.
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}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
authorization
|
path | True |
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization". |
|
policy
|
path | True |
string |
Nome da atribuição de política. |
policy
|
path | True |
O nome do recurso virtual em Tipo de recurso PolicyEvents; só é permitida a "predefinição". |
|
resource
|
path | True |
string |
Nome do grupo de recursos. |
subscription
|
path | True |
string |
ID da subscrição do Microsoft Azure. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
$apply
|
query |
string |
OData aplica expressão para agregações. |
|
$filter
|
query |
string |
Expressão de filtro OData. |
|
$from
|
query |
string date-time |
Carimbo de data/hora formatado ISO 8601 que especifica a hora de início do intervalo para consulta. Quando não for especificado, o serviço utiliza ($to - 1 dia). |
|
$orderby
|
query |
string |
Ordenar expressão com notação OData. Um ou mais nomes de colunas separadas por vírgulas com um "desc" opcional (a predefinição) ou "asc", por exemplo, "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Selecione expressão com notação OData. Limita as colunas em cada registo apenas às pedidas, por exemplo, "$select=PolicyAssignmentId, ResourceId". |
|
$skiptoken
|
query |
string |
O skiptoken só é fornecido se uma resposta anterior devolver um resultado parcial como parte do elemento nextLink. |
|
$to
|
query |
string date-time |
Carimbo de data/hora formatado ISO 8601 que especifica a hora de fim do intervalo para consulta. Quando não for especificado, o serviço utiliza o tempo de pedido. |
|
$top
|
query |
integer int32 |
Número máximo de registos a devolver. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Resultados da consulta. |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
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
Sample Request
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
Sample Response
{
"@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
Sample Request
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
Sample Response
{
"@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"
}
]
}
Definições
Name | Description |
---|---|
Authorization |
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization". |
Component |
Detalhes do evento do componente. |
Error |
Definição de erro. |
Policy |
Registo de eventos de política. |
Policy |
Resultados da consulta. |
Policy |
O nome do recurso virtual em Tipo de recurso PolicyEvents; só é permitida a "predefinição". |
Query |
Resposta de erro. |
AuthorizationNamespaceType
O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization".
Name | Tipo | Description |
---|---|---|
Microsoft.Authorization |
string |
ComponentEventDetails
Detalhes do evento do componente.
Name | Tipo | Description |
---|---|---|
id |
string |
ID do componente. |
name |
string |
Nome do componente. |
policyDefinitionAction |
string |
Ação de definição de política, ou seja, efeito. |
principalOid |
string |
ID de objeto principal para o utilizador que iniciou a operação do componente de recurso que acionou o evento de política. |
tenantId |
string |
ID do inquilino do registo de eventos de política. |
timestamp |
string |
Carimbo de data/hora para o registo de eventos da política de componentes. |
type |
string |
Tipo de componente. |
Error
Definição de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro específico do serviço que serve como o subtatus para o código de erro HTTP. |
message |
string |
Descrição do erro. |
PolicyEvent
Registo de eventos de política.
Name | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações do tipo com base em metadados. |
@odata.id |
string |
ID da entidade OData; sempre definido como nulo, uma vez que os registos de eventos de política não têm um ID de entidade. |
complianceState |
string |
Estado de conformidade do recurso. |
components |
Os registos de eventos de componentes são preenchidos apenas quando o URL contém a cláusula $expand=components. |
|
effectiveParameters |
string |
Parâmetros eficazes para a atribuição de políticas. |
isCompliant |
boolean |
Sinalize o que indica se o recurso está em conformidade com a atribuição de política em que foi avaliado. |
managementGroupIds |
string |
Lista separada por vírgulas de IDs de grupo de gestão, que representam a hierarquia dos grupos de gestão em que o recurso se encontra. |
policyAssignmentId |
string |
ID de atribuição de política. |
policyAssignmentName |
string |
Nome da atribuição de política. |
policyAssignmentOwner |
string |
Proprietário da atribuição de políticas. |
policyAssignmentParameters |
string |
Parâmetros de atribuição de políticas. |
policyAssignmentScope |
string |
Âmbito da atribuição de políticas. |
policyDefinitionAction |
string |
Ação de definição de política, ou seja, efeito. |
policyDefinitionCategory |
string |
Categoria de definição de política. |
policyDefinitionId |
string |
ID de definição de política. |
policyDefinitionName |
string |
Nome da definição de política. |
policyDefinitionReferenceId |
string |
ID de referência para a definição de política dentro do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionCategory |
string |
Categoria de definição de conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionId |
string |
ID de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionName |
string |
Nome da definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionOwner |
string |
Proprietário da definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
policySetDefinitionParameters |
string |
Parâmetros de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas. |
principalOid |
string |
ID de objeto principal para o utilizador que iniciou a operação de recurso que acionou o evento de política. |
resourceGroup |
string |
Nome do grupo de recursos. |
resourceId |
string |
ID do Recurso. |
resourceLocation |
string |
Localização do recurso. |
resourceTags |
string |
Lista de etiquetas de recursos. |
resourceType |
string |
Tipo de recurso. |
subscriptionId |
string |
ID da Subscrição. |
tenantId |
string |
ID do inquilino do registo de eventos de política. |
timestamp |
string |
Carimbo de data/hora para o registo de eventos de política. |
PolicyEventsQueryResults
Resultados da consulta.
Name | Tipo | Description |
---|---|---|
@odata.context |
string |
Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações do tipo com base em metadados. |
@odata.count |
integer |
Contagem de entidades OData; representa o número de registos de eventos de política devolvidos. |
@odata.nextLink |
string |
Ligação seguinte do Odata; URL para obter o próximo conjunto de resultados. |
value |
Resultados da consulta. |
PolicyEventsResourceType
O nome do recurso virtual em Tipo de recurso PolicyEvents; só é permitida a "predefinição".
Name | Tipo | Description |
---|---|---|
default |
string |
QueryFailure
Resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
Definição de erro. |