Component Policy States - List Query Results For Resource Group Level Policy Assignment

Referência

Service:: Policy

API Version:: 2022-04-01

Os estados da política de componentes de consultas 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/componentPolicyStates/latest/queryResults?api-version=2022-04-01

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/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
authorizationNamespace	path	True	AuthorizationNamespaceType	O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization".
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	O recurso virtual em ComponentPolicyStates tipo de recurso. Num determinado intervalo de tempo, "mais recente" representa os estados da política de componentes mais recentes.
policyAssignmentName	path	True	string	Nome da atribuição de política. Regex pattern: `^[^<>%&:\\?/#]*$`
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 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".
$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	ComponentPolicyStatesQueryResults	Resultados da consulta.
Other Status Codes	ErrorResponse	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 latest 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/componentPolicyStates/latest/queryResults?api-version=2022-04-01

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_level_policy_assignment_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_level_policy_assignment(
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        resource_group_name="myResourceGroup",
        policy_assignment_name="myPolicyAssignment",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.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

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

/**
 * This sample demonstrates how to Queries component policy states for the resource group level policy assignment.
 *
 * @summary Queries component policy states for the resource group level policy assignment.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json
 */
async function queryLatestAtResourceGroupLevelPolicyAssignmentScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["POLICYINSIGHTS_RESOURCE_GROUP"] || "myResourceGroup";
  const policyAssignmentName = "myPolicyAssignment";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result =
    await client.componentPolicyStates.listQueryResultsForResourceGroupLevelPolicyAssignment(
      subscriptionId,
      resourceGroupName,
      policyAssignmentName,
      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/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/componentPolicyStates/$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.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
      "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/4a0425e4-97bf-4ad0-ab36-145b94083c60",
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": null,
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
      "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@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/componentPolicyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
      "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/4a0425e4-97bf-4ad0-ab36-145b94083c60",
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": null,
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
      "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": null,
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Definições

Name	Description
AuthorizationNamespaceType	O espaço de nomes do fornecedor de recursos de Autorização da Microsoft; só é permitido "Microsoft.Authorization".
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 da política de componentes mais recentes.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
TypedErrorInfo	Detalhes de erro específicos do cenário.

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

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.