Policy Events - List Query Results For Resource Group
查询资源组下资源的策略事件。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01
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}
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
policy
|
path | True |
PolicyEvents 资源类型下的虚拟资源的名称;仅允许“default”。 |
|
|
resource
|
path | True |
string |
资源组名称。 |
|
subscription
|
path | True |
string |
Microsoft Azure subscription ID. |
|
api-version
|
query | True |
string |
客户端 API 版本。 |
|
$apply
|
query |
string |
OData 为聚合应用表达式。 |
|
|
$filter
|
query |
string |
OData 筛选器表达式。 |
|
|
$from
|
query |
string (date-time) |
ISO 8601 格式化时间戳,指定要查询的时间间隔的开始时间。 如果未指定,服务将使用 ($to - 1 天)。 |
|
|
$orderby
|
query |
string |
使用 OData 表示法对表达式进行排序。 一个或多个逗号分隔的列名,其可选“desc”(默认值)或“asc”,例如“$orderby=PolicyAssignmentId, ResourceId asc”。 |
|
|
$select
|
query |
string |
使用 OData 表示法选择表达式。 将每个记录上的列限制为仅请求的列,例如“$select=PolicyAssignmentId, ResourceId”。 |
|
|
$skiptoken
|
query |
string |
仅当上一个响应作为 nextLink 元素的一部分返回部分结果时,才提供 Skiptoken。 |
|
|
$to
|
query |
string (date-time) |
ISO 8601 格式的时间戳,用于指定要查询的时间间隔的结束时间。 如果未指定,服务将使用请求时间。 |
|
|
$top
|
query |
integer (int32) minimum: 0 |
要返回的最大记录数。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
查询结果。 |
|
| Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
| Query at resource group scope |
| Query at resource group scope with next link |
Query at resource group scope
示例请求
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01
示例响应
{
"@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
示例请求
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
示例响应
{
"@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"
}
]
}
定义
| 名称 | 说明 |
|---|---|
|
Component |
组件事件详细信息。 |
| Error |
错误定义。 |
|
Policy |
策略事件记录。 |
|
Policy |
查询结果。 |
|
Policy |
PolicyEvents 资源类型下的虚拟资源的名称;仅允许“default”。 |
|
Query |
错误响应。 |
ComponentEventDetails
组件事件详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
组件 ID。 |
| name |
string |
组件名称。 |
| policyDefinitionAction |
string |
策略定义操作,即效果。 |
| principalOid |
string |
启动触发策略事件的资源组件操作的用户的主体对象 ID。 |
| tenantId |
string |
策略事件记录的租户 ID。 |
| timestamp |
string (date-time) |
组件策略事件记录的时间戳。 |
| type |
string |
组件类型。 |
Error
错误定义。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
服务特定的错误代码,用作 HTTP 错误代码的子状态。 |
| message |
string |
错误说明。 |
PolicyEvent
策略事件记录。
| 名称 | 类型 | 说明 |
|---|---|---|
| @odata.context |
string |
OData 上下文字符串;由 OData 客户端用来根据元数据解析类型信息。 |
| @odata.id |
string |
OData 实体 ID;始终设置为 null,因为策略事件记录没有实体 ID。 |
| complianceState |
string |
资源的符合性状态。 |
| components |
仅当 URL 包含 $expand=components 子句时,才会填充组件事件记录。 |
|
| effectiveParameters |
string |
策略分配的有效参数。 |
| isCompliant |
boolean |
标记,指示资源是否符合其评估的策略分配。 |
| managementGroupIds |
string |
以逗号分隔的管理组 ID 列表,表示资源所在的管理组的层次结构。 |
| policyAssignmentId |
string |
策略分配 ID。 |
| policyAssignmentName |
string |
策略分配名称。 |
| policyAssignmentOwner |
string |
策略分配所有者。 |
| policyAssignmentParameters |
string |
策略分配参数。 |
| policyAssignmentScope |
string |
策略分配范围。 |
| policyDefinitionAction |
string |
策略定义操作,即效果。 |
| policyDefinitionCategory |
string |
策略定义类别。 |
| policyDefinitionId |
string |
策略定义 ID。 |
| policyDefinitionName |
string |
策略定义名称。 |
| policyDefinitionReferenceId |
string |
策略集中策略定义的引用 ID(如果策略分配用于策略集)。 |
| policySetDefinitionCategory |
string |
策略集定义类别(如果策略分配用于策略集)。 |
| policySetDefinitionId |
string |
策略集定义 ID(如果策略分配用于策略集)。 |
| policySetDefinitionName |
string |
策略集定义名称(如果策略分配用于策略集)。 |
| policySetDefinitionOwner |
string |
策略集定义所有者(如果策略分配用于策略集)。 |
| policySetDefinitionParameters |
string |
策略集定义参数(如果策略分配用于策略集)。 |
| principalOid |
string |
启动触发策略事件的资源操作的用户的主体对象 ID。 |
| resourceGroup |
string |
资源组名称。 |
| resourceId |
string |
资源 ID。 |
| resourceLocation |
string |
资源位置。 |
| resourceTags |
string |
资源标记列表。 |
| resourceType |
string |
资源类型。 |
| subscriptionId |
string |
订阅 ID。 |
| tenantId |
string |
策略事件记录的租户 ID。 |
| timestamp |
string (date-time) |
策略事件记录的时间戳。 |
PolicyEventsQueryResults
查询结果。
| 名称 | 类型 | 说明 |
|---|---|---|
| @odata.context |
string |
OData 上下文字符串;由 OData 客户端用来根据元数据解析类型信息。 |
| @odata.count |
integer (int32) minimum: 0 |
OData 实体计数;表示返回的策略事件记录数。 |
| @odata.nextLink |
string |
Odata 下一个链接;用于获取下一组结果的 URL。 |
| value |
查询结果。 |
PolicyEventsResourceType
PolicyEvents 资源类型下的虚拟资源的名称;仅允许“default”。
| 值 | 说明 |
|---|---|
| default |
QueryFailure
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误定义。 |