Component Policy States - List Query Results For Resource Group

Service:

Policy

API Version:

2022-04-01

Consulta os estados da política de componentes no âmbito do grupo de recursos.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	O recurso virtual em ComponentPolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados mais recentes da política de componentes.
resourceGroupName	path	True	string	Nome do grupo de recursos.
subscriptionId	path	True	string	ID da subscrição do 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	IsO 8601 formatado carimbo de data/hora especificando a hora de início do intervalo a consultar. Quando não for especificado, o serviço utiliza ($to - 1 dia).
$orderby	query		string	Expressão de ordenação com notação OData. Um ou mais nomes de coluna separados 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 a notação OData. Limita as colunas em cada registo apenas às pedidas, por exemplo, "$select=PolicyAssignmentId, ResourceId".
$to	query		string date-time	IsO 8601 formatado carimbo de data/hora especificando 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	ComponentPolicyStatesQueryResults	Resultados da consulta.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo 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 latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment.

Query latest component policy states at resource group scope

Query latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=policyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'&$apply=groupby((type,complianceState),aggregate($count as count))

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python component_policy_states_query_resource_group_scope_group_by_component_type_with_aggregate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
    )

    response = client.component_policy_states.list_query_results_for_resource_group(
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        resource_group_name="myResourceGroup",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Queries component policy states under resource group scope.
 *
 * @summary Queries component policy states under resource group scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json
 */
async function queryLatestComponentPolicyComplianceStateCountGroupedByComponentTypeAtResourceGroupScopeFilteredByGivenAssignment() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["POLICYINSIGHTS_RESOURCE_GROUP"] || "myResourceGroup";
  const componentPolicyStatesResource = "latest";
  const filter =
    "policyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'";
  const apply = "groupby((type,complianceState),aggregate($count as count))";
  const options = {
    filter,
    apply,
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResourceGroup(
    subscriptionId,
    resourceGroupName,
    componentPolicyStatesResource,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "componentType": "Certificate",
      "complianceState": "NonCompliant",
      "count": 26
    },
    {
      "componentType": "Certificate",
      "complianceState": "Compliant",
      "count": 10
    }
  ]
}

Query latest component policy states at resource group scope

Sample Request

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python component_policy_states_query_resource_group_scope.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
    )

    response = client.component_policy_states.list_query_results_for_resource_group(
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        resource_group_name="myResourceGroup",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Queries component policy states under resource group scope.
 *
 * @summary Queries component policy states under resource group scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json
 */
async function queryLatestComponentPolicyStatesAtResourceGroupScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["POLICYINSIGHTS_RESOURCE_GROUP"] || "myResourceGroup";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResourceGroup(
    subscriptionId,
    resourceGroupName,
    componentPolicyStatesResource
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
      "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
      "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "complianceReasonCode": "tbd",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "cert-RSA-cert-2",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-2",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
      "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
      "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "complianceReasonCode": "tbd",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Definições

Name	Description
ComponentExpressionEvaluationDetails	Detalhes de avaliação das expressões de linguagem de política.
ComponentPolicyEvaluationDetails	Detalhes da avaliação da política.
ComponentPolicyState	Registo de Estado da Política de Componente.
ComponentPolicyStatesQueryResults	Resultados da consulta.
ComponentPolicyStatesResource	O recurso virtual em ComponentPolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados mais recentes da política de componentes.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
TypedErrorInfo	Detalhes de erros específicos do cenário.

ComponentExpressionEvaluationDetails

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

Name	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.

ComponentPolicyEvaluationDetails

Detalhes da avaliação da política.

Name	Tipo	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Detalhes das expressões avaliadas.
reason	string	Motivo textual adicional para o resultado da avaliação.

ComponentPolicyState

Registo de Estado da Política de Componente.

Name	Tipo	Description
@odata.context	string	Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.id	string	ID da entidade OData; sempre definido como nulo, uma vez que os registos de estado da política de componentes não têm um ID de entidade.
complianceState	string	Estado de conformidade do recurso.
componentId	string	ID do componente.
componentName	string	Nome do componente.
componentType	string	Tipo de componente.
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ítica.
policyAssignmentParameters	string	Parâmetros de atribuição de políticas.
policyAssignmentScope	string	Âmbito de atribuição de políticas.
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 grupos 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.
policyDefinitionVersion	string	Versão de definição de política avaliada.
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Detalhes da avaliação da política. Isto só é incluído na resposta se o pedido contiver $expand=PolicyEvaluationDetails.
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 de 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	Localização do recurso.
resourceType	string	Tipo de recurso.
subscriptionId	string	ID da Subscrição.
timestamp	string	Carimbo de data/hora do registo de estado da política de componentes.

ComponentPolicyStatesQueryResults

Resultados da consulta.

Name	Tipo	Description
@odata.context	string	Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.count	integer	Contagem de entidades OData; representa o número de registos de estado de política devolvidos.
value	ComponentPolicyState[]	Resultados da consulta.

ComponentPolicyStatesResource

O recurso virtual em ComponentPolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados mais recentes da política de componentes.

Name	Tipo	Description
latest	string

ErrorDefinition

Definição de erro.

Name	Tipo	Description
additionalInfo	TypedErrorInfo[]	Detalhes de erros específicos de cenários adicionais.
code	string	Código de erro específico do serviço que serve como subestado para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes internos do erro.
message	string	Descrição do erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

TypedErrorInfo

Detalhes de erros específicos do cenário.

Name	Tipo	Description
info		Os detalhes de erro específicos do cenário.
type	string	O tipo de detalhes de erro incluídos.