Policy States - List Query Results For Resource Group

Serviço:: Policy

Versão da API:: 2024-10-01

Consulta os estados de política para os recursos no grupo de recursos.

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

Com parâmetros opcionais:

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}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policyStatesResource	path	True	PolicyStatesResource	O recurso virtual no tipo de recurso PolicyStates. Em um determinado intervalo de tempo, 'latest' representa os estados de política mais recentes, enquanto 'default' representa todos os estados de política.
resourceGroupName	path	True	string	Nome do grupo de recursos.
subscriptionId	path	True	string	ID de subscrição Microsoft Azure.
api-version	query	True	string	Versão da API do 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 especificando a hora de início do intervalo a ser consultado. Quando não especificado, o serviço usa ($to – 1 dia).
$orderby	query		string	Ordenando expressão usando a notação OData. Um ou mais nomes de coluna separados por vírgulas com um "desc" opcional (o padrão) ou "asc", por exemplo, "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Selecione a expressão usando a notação OData. Limita as colunas em cada registro apenas às solicitadas, por exemplo, "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken só será fornecido se uma resposta anterior retornar um resultado parcial como parte do elemento nextLink.
$to	query		string (date-time)	Carimbo de data/hora formatado iso 8601 especificando a hora de término do intervalo a ser consultado. Quando não especificado, o serviço usa o tempo de solicitação.
$top	query		integer (int32) minimum: 0	Número máximo de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	PolicyStatesQueryResults	Resultados da consulta.
Other Status Codes	QueryFailure	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
      ]
    }
  ]
}

Definições

Nome	Description
ComponentStateDetails	Detalhes do estado do componente.
Error	Definição de erro.
ExpressionEvaluationDetails	Detalhes de avaliação de expressões de linguagem de política.
IfNotExistsEvaluationDetails	Detalhes de avaliação do efeito IfNotExists.
PolicyEvaluationDetails	Detalhes da avaliação da política.
PolicyState	Registro de estado da política.
PolicyStatesQueryResults	Resultados da consulta.
PolicyStatesResource	O recurso virtual no tipo de recurso PolicyStates. Em um determinado intervalo de tempo, 'latest' representa os estados de política mais recentes, enquanto 'default' representa todos os estados de política.
QueryFailure	Resposta de erro.

ComponentStateDetails

Objeto

Detalhes do estado do componente.

Nome	Tipo	Description
complianceState	string	Estado de conformidade do componente.
id	string	ID do componente.
name	string	Nome do componente.
timestamp	string (date-time)	Carimbo de data/hora de avaliação de conformidade do componente.
type	string	Tipo de componente.

Error

Objeto

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
message	string	Descrição do erro.

ExpressionEvaluationDetails

Objeto

Detalhes de avaliação de expressões de linguagem de política.

Nome	Tipo	Description
expression	string	Expressão avaliada.
expressionKind	string	O tipo de expressão que foi avaliada.
expressionValue	object	Valor da expressão.
operator	string	Operador para comparar o valor da expressão e o valor de destino.
path	string	Caminho da propriedade se a expressão for um campo ou um alias.
result	string	Resultado da avaliação.
targetValue	object	Valor de destino a ser comparado com o valor da expressão.

IfNotExistsEvaluationDetails

Objeto

Detalhes de avaliação do efeito IfNotExists.

Nome	Tipo	Description
resourceId	string	ID do último recurso avaliado para efeito IfNotExists.
totalResources	integer	Número total de recursos aos quais a condição de existência é aplicável.

PolicyEvaluationDetails

Objeto

Detalhes da avaliação da política.

Nome	Tipo	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Detalhes das expressões avaliadas.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Detalhes de avaliação do efeito IfNotExists.

PolicyState

Objeto

Registro de estado da política.

Nome	Tipo	Description
@odata.context	string	Cadeia de caracteres de contexto OData; usado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.id	string	ID da entidade OData; sempre definido como nulo, pois os registros de estado da política não têm uma ID de entidade.
complianceState	string	Estado de conformidade do recurso.
components	ComponentStateDetails[]	Os registros de conformidade de estado dos componentes são preenchidos somente quando a URL contém a cláusula $expand=components.
effectiveParameters	string	Parâmetros efetivos para a atribuição de política.
isCompliant	boolean	Sinalizador que indica se o recurso está em conformidade com a atribuição de política em que foi avaliado. Esta propriedade foi preterida; Em vez disso, use ComplianceState.
managementGroupIds	string	Lista separada por vírgulas de IDs de grupo de gerenciamento, que representam a hierarquia dos grupos de gerenciamento em que o recurso está.
policyAssignmentId	string	ID da atribuição de política.
policyAssignmentName	string	Nome da atribuição de política.
policyAssignmentOwner	string	Proprietário da atribuição de política.
policyAssignmentParameters	string	Parâmetros de atribuição de política.
policyAssignmentScope	string	Escopo da atribuição de política.
policyAssignmentVersion	string	Versão de atribuição de política avaliada.
policyDefinitionAction	string	Ação de definição de política, ou seja, efeito.
policyDefinitionCategory	string	Categoria de definição de política.
policyDefinitionGroupNames	string[]	Nomes de grupo de definição de política.
policyDefinitionId	string	ID de definição de política.
policyDefinitionName	string	Nome da definição da 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.
policyDefinitionVersion	string	Versão de definição de política avaliada.
policyEvaluationDetails	PolicyEvaluationDetails	Detalhes da avaliação da política.
policySetDefinitionCategory	string	Categoria de definição do 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.
policySetDefinitionVersion	string	Versão de definição do conjunto de políticas avaliada.
resourceGroup	string	Nome do grupo de recursos.
resourceId	string	ID do recurso.
resourceLocation	string	Local do recurso.
resourceTags	string	Lista de marcas de recurso.
resourceType	string	Tipo de recurso.
subscriptionId	string	ID da assinatura.
timestamp	string (date-time)	Carimbo de data/hora do registro de estado da política.

PolicyStatesQueryResults

Objeto

Resultados da consulta.

Nome	Tipo	Description
@odata.context	string	Cadeia de caracteres de contexto OData; usado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.count	integer (int32) minimum: 0	Contagem de entidades OData; representa o número de registros de estado da política retornados.
@odata.nextLink	string	Próximo link do Odata; URL para obter o próximo conjunto de resultados.
value	PolicyState[]	Resultados da consulta.

PolicyStatesResource

Enumeração

O recurso virtual no tipo de recurso PolicyStates. Em um determinado intervalo de tempo, 'latest' representa os estados de política mais recentes, enquanto 'default' representa todos os estados de política.

Valor	Description
default
latest

QueryFailure

Objeto

Resposta de erro.

Nome	Tipo	Description
error	Error	Definição de erro.

Compartilhar via

Policy States - List Query Results For Resource Group

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Query latest at resource group scope

Solicitação de exemplo

Resposta de exemplo

Query latest at resource group scope with next link

Solicitação de exemplo

Resposta de exemplo

Definições

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure