你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Policy States - List Query Results For Resource Group

服务:: Policy

API 版本:: 2024-10-01

查询资源组下资源的策略状态。

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

具有可选参数:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2024-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

URI 参数

名称	在	必需	类型	说明
policyStatesResource	path	True	PolicyStatesResource	PolicyStates 资源类型下的虚拟资源。在给定的时间范围内，“latest”表示最新的策略状态（s），而“default”表示所有策略状态（s）。
resourceGroupName	path	True	string	资源组名称。
subscriptionId	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	PolicyStatesQueryResults	查询结果。
Other Status Codes	QueryFailure	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Query latest at resource group scope with next link

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    }
  ]
}

定义

名称	说明
ComponentStateDetails	组件状态详细信息。
Error	错误定义。
ExpressionEvaluationDetails	策略语言表达式的计算详细信息。
IfNotExistsEvaluationDetails	IfNotExists 效果的评估详细信息。
PolicyEvaluationDetails	策略评估详细信息。
PolicyState	策略状态记录。
PolicyStatesQueryResults	查询结果。
PolicyStatesResource	PolicyStates 资源类型下的虚拟资源。在给定的时间范围内，“latest”表示最新的策略状态（s），而“default”表示所有策略状态（s）。
QueryFailure	错误响应。

ComponentStateDetails

对象

组件状态详细信息。

名称	类型	说明
complianceState	string	组件符合性状态。
id	string	组件 ID。
name	string	组件名称。
timestamp	string (date-time)	组件符合性评估时间戳。
type	string	组件类型。

Error

对象

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
message	string	错误说明。

ExpressionEvaluationDetails

对象

策略语言表达式的计算详细信息。

名称	类型	说明
expression	string	计算表达式。
expressionKind	string	计算的表达式类型。
expressionValue	object	表达式的值。
operator	string	用于比较表达式值和目标值的运算符。
path	string	如果表达式是字段或别名，则属性路径。
result	string	评估结果。
targetValue	object	要与表达式值进行比较的目标值。

IfNotExistsEvaluationDetails

对象

IfNotExists 效果的评估详细信息。

名称	类型	说明
resourceId	string	IfNotExists 效果的最后一个评估资源 ID。
totalResources	integer	存在条件适用的资源总数。

PolicyEvaluationDetails

对象

策略评估详细信息。

名称	类型	说明
evaluatedExpressions	ExpressionEvaluationDetails[]	计算表达式的详细信息。
ifNotExistsDetails	IfNotExistsEvaluationDetails	IfNotExists 效果的评估详细信息。

PolicyState

对象

策略状态记录。

名称	类型	说明
@odata.context	string	OData 上下文字符串;由 OData 客户端用来根据元数据解析类型信息。
@odata.id	string	OData 实体 ID;始终设置为 null，因为策略状态记录没有实体 ID。
complianceState	string	资源的符合性状态。
components	ComponentStateDetails[]	仅当 URL 包含 $expand=components 子句时填充的组件状态符合性记录。
effectiveParameters	string	策略分配的有效参数。
isCompliant	boolean	标记，指示资源是否符合其评估的策略分配。此属性已弃用;请改用 ComplianceState。
managementGroupIds	string	以逗号分隔的管理组 ID 列表，表示资源所在的管理组的层次结构。
policyAssignmentId	string	策略分配 ID。
policyAssignmentName	string	策略分配名称。
policyAssignmentOwner	string	策略分配所有者。
policyAssignmentParameters	string	策略分配参数。
policyAssignmentScope	string	策略分配范围。
policyAssignmentVersion	string	评估的策略分配版本。
policyDefinitionAction	string	策略定义操作，即效果。
policyDefinitionCategory	string	策略定义类别。
policyDefinitionGroupNames	string[]	策略定义组名称。
policyDefinitionId	string	策略定义 ID。
policyDefinitionName	string	策略定义名称。
policyDefinitionReferenceId	string	策略集中策略定义的引用 ID（如果策略分配用于策略集）。
policyDefinitionVersion	string	评估的策略定义版本。
policyEvaluationDetails	PolicyEvaluationDetails	策略评估详细信息。
policySetDefinitionCategory	string	策略集定义类别（如果策略分配用于策略集）。
policySetDefinitionId	string	策略集定义 ID（如果策略分配用于策略集）。
policySetDefinitionName	string	策略集定义名称（如果策略分配用于策略集）。
policySetDefinitionOwner	string	策略集定义所有者（如果策略分配用于策略集）。
policySetDefinitionParameters	string	策略集定义参数（如果策略分配用于策略集）。
policySetDefinitionVersion	string	评估的策略集定义版本。
resourceGroup	string	资源组名称。
resourceId	string	资源 ID。
resourceLocation	string	资源位置。
resourceTags	string	资源标记列表。
resourceType	string	资源类型。
subscriptionId	string	订阅 ID。
timestamp	string (date-time)	策略状态记录的时间戳。

PolicyStatesQueryResults

对象

查询结果。

名称	类型	说明
@odata.context	string	OData 上下文字符串;由 OData 客户端用来根据元数据解析类型信息。
@odata.count	integer (int32) minimum: 0	OData 实体计数;表示返回的策略状态记录数。
@odata.nextLink	string	Odata 下一个链接;用于获取下一组结果的 URL。
value	PolicyState[]	查询结果。

PolicyStatesResource

枚举

PolicyStates 资源类型下的虚拟资源。在给定的时间范围内，“latest”表示最新的策略状态（s），而“default”表示所有策略状态（s）。

值	说明
default
latest

QueryFailure

对象

错误响应。

名称	类型	说明
error	Error	错误定义。

通过

Policy States - List Query Results For Resource Group

URI 参数

响应

安全性

azure_auth

作用域

示例

Query latest at resource group scope

示例请求

示例响应

Query latest at resource group scope with next link

示例请求

示例响应

定义

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure