Component Policy States - List Query Results For Subscription

Service:

Policy

API Version:

2022-04-01

Consulta los estados de la directiva de componentes en el ámbito de la suscripción.

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

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/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 de identificador URI

Nombre	En	Requerido	Tipo	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	El recurso virtual debajo del tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.
subscriptionId	path	True	string	Identificador de suscripción de Microsoft Azure.
api-version	query	True	string	Versión de api de cliente.
$apply	query		string	OData aplica expresión para agregaciones.
$filter	query		string	Expresión de filtro de OData.
$from	query		string date-time	Marca de tiempo con formato ISO 8601 que especifica la hora de inicio del intervalo que se va a consultar. Cuando no se especifica, el servicio usa ($to - 1 día).
$orderby	query		string	Expresión de ordenación mediante notación de OData. Uno o varios nombres de columna separados por comas con un "desc" opcional (el valor predeterminado) o "asc", por ejemplo, "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Seleccione la expresión mediante la notación OData. Limita las columnas de cada registro solo a las solicitadas, por ejemplo, "$select=PolicyAssignmentId, ResourceId".
$to	query		string date-time	Marca de tiempo con formato ISO 8601 que especifica la hora de finalización del intervalo que se va a consultar. Cuando no se especifica, el servicio usa el tiempo de solicitud.
$top	query		integer int32	Número máximo de registros que se van a devolver.

Respuestas

Nombre	Tipo	Description
200 OK	ComponentPolicyStatesQueryResults	Resultados de la consulta.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Query latest component policy states at subscription scope

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

Sample Request

HTTP

POST https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'&$apply=groupby((componentType,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_subscription_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="e78961ba-36fe-4739-9212-e3031b4c8db7",
    )

    response = client.component_policy_states.list_query_results_for_subscription(
        subscription_id="e78961ba-36fe-4739-9212-e3031b4c8db7",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.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 subscription scope.
 *
 * @summary Queries component policy states under subscription scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json
 */
async function queryLatestComponentPolicyComplianceStateCountGroupedByComponentTypeAtSubscriptionScopeFilteredByGivenAssignment() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const componentPolicyStatesResource = "latest";
  const filter =
    "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'";
  const apply = "groupby((componentType,complianceState),aggregate($count as count))";
  const options = {
    filter,
    apply,
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForSubscription(
    subscriptionId,
    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/e78961ba-36fe-4739-9212-e3031b4c8db7/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 subscription scope

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/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_subscription_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="fff10b27-fff3-fff5-fff8-fffbe01e86a5",
    )

    response = client.component_policy_states.list_query_results_for_subscription(
        subscription_id="fff10b27-fff3-fff5-fff8-fffbe01e86a5",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScope.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 subscription scope.
 *
 * @summary Queries component policy states under subscription scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json
 */
async function queryLatestComponentPolicyStatesAtSubscriptionScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForSubscription(
    subscriptionId,
    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/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/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/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"
    }
  ]
}

Definiciones

Nombre	Description
ComponentExpressionEvaluationDetails	Detalles de evaluación de expresiones de lenguaje de directiva.
ComponentPolicyEvaluationDetails	Detalles de evaluación de directivas.
ComponentPolicyState	Registro de estado de la directiva de componentes.
ComponentPolicyStatesQueryResults	Resultados de la consulta.
ComponentPolicyStatesResource	El recurso virtual debajo del tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.
ErrorDefinition	Definición de error.
ErrorResponse	Respuesta de error.
TypedErrorInfo	Detalles de error específicos del escenario.

ComponentExpressionEvaluationDetails

Detalles de evaluación de expresiones de lenguaje de directiva.

Nombre	Tipo	Description
expression	string	Expresión evaluada.
expressionKind	string	Tipo de expresión que se evaluó.
expressionValue	object	Valor de la expresión.
operator	string	Operador para comparar el valor de expresión y el valor de destino.
path	string	Ruta de acceso de propiedad si la expresión es un campo o un alias.
result	string	Resultado de la evaluación.
targetValue	object	Valor de destino que se va a comparar con el valor de expresión.

ComponentPolicyEvaluationDetails

Detalles de evaluación de directivas.

Nombre	Tipo	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Detalles de las expresiones evaluadas.
reason	string	Motivo textual adicional para el resultado de la evaluación.

ComponentPolicyState

Registro de estado de la directiva de componentes.

Nombre	Tipo	Description
@odata.context	string	Cadena de contexto de OData; usado por los clientes de OData para resolver la información de tipos en función de los metadatos.
@odata.id	string	Identificador de entidad de OData; siempre se establece en NULL, ya que los registros de estado de la directiva de componentes no tienen un identificador de entidad.
complianceState	string	Estado de cumplimiento del recurso.
componentId	string	Id. de componente.
componentName	string	component_name
componentType	string	Tipo de componente.
policyAssignmentId	string	Id. de asignación de directiva.
policyAssignmentName	string	Nombre de asignación de directiva.
policyAssignmentOwner	string	Propietario de la asignación de directiva.
policyAssignmentParameters	string	Parámetros de asignación de directivas.
policyAssignmentScope	string	Ámbito de asignación de directiva.
policyAssignmentVersion	string	Versión de asignación de directiva evaluada.
policyDefinitionAction	string	Acción de definición de directiva, es decir, efecto.
policyDefinitionCategory	string	Categoría de definición de directiva.
policyDefinitionGroupNames	string[]	Nombres de grupo de definición de directiva.
policyDefinitionId	string	Identificador de definición de directiva.
policyDefinitionName	string	Nombre de definición de directiva.
policyDefinitionReferenceId	string	Identificador de referencia para la definición de directiva dentro del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policyDefinitionVersion	string	Versión de definición de directiva evaluada.
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Detalles de evaluación de directivas. Esto solo se incluye en la respuesta si la solicitud contiene $expand=PolicyEvaluationDetails.
policySetDefinitionCategory	string	Categoría de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionId	string	Identificador de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionName	string	Nombre de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionOwner	string	Propietario de la definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionParameters	string	Parámetros de definición del conjunto de directivas, si la asignación de directiva es para un conjunto de directivas.
policySetDefinitionVersion	string	Versión de definición del conjunto de directivas evaluada.
resourceGroup	string	Nombre del grupo de recursos.
resourceId	string	Identificador del recurso.
resourceLocation	string	Ubicación del recurso
resourceType	string	Tipo de recurso.
subscriptionId	string	Id. de suscripción.
timestamp	string	Marca de tiempo para el registro de estado de la directiva de componentes.

ComponentPolicyStatesQueryResults

Resultados de la consulta.

Nombre	Tipo	Description
@odata.context	string	Cadena de contexto de OData; usado por los clientes de OData para resolver la información de tipos en función de los metadatos.
@odata.count	integer	Recuento de entidades de OData; representa el número de registros de estado de directiva devueltos.
value	ComponentPolicyState[]	Resultados de la consulta.

ComponentPolicyStatesResource

El recurso virtual debajo del tipo de recurso ComponentPolicyStates. En un intervalo de tiempo determinado, "latest" representa los estados de directiva de componentes más recientes.

Nombre	Tipo	Description
latest	string

ErrorDefinition

Definición de error.

Nombre	Tipo	Description
additionalInfo	TypedErrorInfo[]	Detalles adicionales del error específico del escenario.
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	ErrorDefinition[]	Detalles internos del error.
message	string	Descripción del error.
target	string	Destino del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	ErrorDefinition	Los detalles del error.

TypedErrorInfo

Detalles de error específicos del escenario.

Nombre	Tipo	Description
info		Detalles específicos del error del escenario.
type	string	Tipo de detalles de error incluidos.