Component Policy States - List Query Results For Resource

Service:

Policy

API Version:

2022-04-01

Interroge les états de stratégie de composant pour la ressource.

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

With optional parameters:

POST https://management.azure.com/{resourceId}/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}&$expand={$expand}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant.
resourceId	path	True	string	ID de la ressource
api-version	query	True	string	Version de l’API cliente.
$apply	query		string	Appliquer une expression OData pour les agrégations.
$expand	query		string	Paramètre de requête $expand.
$filter	query		string	Expression de filtre OData.
$from	query		string date-time	Horodatage au format ISO 8601 spécifiant l’heure de début de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise ($to - 1 jour).
$orderby	query		string	Classement de l’expression à l’aide de la notation OData. Un ou plusieurs noms de colonnes séparés par des virgules avec un « desc » facultatif (valeur par défaut) ou « asc », par exemple « $orderby=PolicyAssignmentId, ResourceId asc ».
$select	query		string	Sélectionnez une expression à l’aide de la notation OData. Limite les colonnes de chaque enregistrement à celles demandées, par exemple « $select=PolicyAssignmentId, ResourceId ».
$to	query		string date-time	Horodatage au format ISO 8601 spécifiant l’heure de fin de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise l’heure de la demande.
$top	query		integer int32	Nombre maximal d’enregistrements à retourner.

Réponses

Nom	Type	Description
200 OK	ComponentPolicyStatesQueryResults	Résultats de la requête.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Query latest component policy compliance state at resource scope filtered by given component id.

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

Query latest component policy states at nested resource scope

Query latest component policy states at resource scope

Query latest component policy states at resource scope and expand policyEvaluationDetails

Query latest component policy compliance state at resource scope filtered by given component id.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=componentId eq cert-RSA-cert-3

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_scope_filter_by_component_id.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="SUBSCRIPTION_ID",
    )

    response = client.component_policy_states.list_query_results_for_resource(
        resource_id="subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.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 for the resource.
 *
 * @summary Queries component policy states for the resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json
 */
async function queryLatestComponentPolicyComplianceStateAtResourceScopeFilteredByGivenComponentId() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName";
  const componentPolicyStatesResource = "latest";
  const filter = "componentId eq cert-RSA-cert-3";
  const options = {
    filter,
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResource(
    resourceId,
    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/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/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.KeyVault/Vaults/myKVName/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/test1",
      "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.KeyVault/Vaults/myKVName/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/test2",
      "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"
    }
  ]
}

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

Sample Request

HTTP

POST https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/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_resource_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="SUBSCRIPTION_ID",
    )

    response = client.component_policy_states.list_query_results_for_resource(
        resource_id="subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.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 for the resource.
 *
 * @summary Queries component policy states for the resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json
 */
async function queryLatestComponentPolicyComplianceStateCountGroupedByComponentTypeAtResourceScopeFilteredByGivenAssignment() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName";
  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.listQueryResultsForResource(
    resourceId,
    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/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 nested resource scope

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault/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_nested_resource_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="SUBSCRIPTION_ID",
    )

    response = client.component_policy_states.list_query_results_for_resource(
        resource_id="subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryNestedResourceScope.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 for the resource.
 *
 * @summary Queries component policy states for the resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryNestedResourceScope.json
 */
async function queryLatestComponentPolicyStatesAtNestedResourceScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResource(
    resourceId,
    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.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$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.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "186044306c044a1d8c0ff76c",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg",
      "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d",
      "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/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2022-04-09T16:04:31Z",
      "componentId": "cert-RSA-cert-3",
      "componentType": "Certificate",
      "componentName": "cert-RSA-cert-3",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c",
      "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d",
      "isCompliant": true,
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.KeyVault/vaults/myVault",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "186044306c044a1d8c0ff76c",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg",
      "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d",
      "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"
    }
  ]
}

Query latest component policy states at resource scope

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/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_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="SUBSCRIPTION_ID",
    )

    response = client.component_policy_states.list_query_results_for_resource(
        resource_id="subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScope.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 for the resource.
 *
 * @summary Queries component policy states for the resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScope.json
 */
async function queryLatestComponentPolicyStatesAtResourceScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResource(
    resourceId,
    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.KeyVault/Vaults/myKVName/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.KeyVault/Vaults/myKVName/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.KeyVault/Vaults/myKVName/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"
    }
  ]
}

Query latest component policy states at resource scope and expand policyEvaluationDetails

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=componentType eq 'pod' AND componentId eq 'default/test-pod' AND componentName eq 'test-pod'&$expand=PolicyEvaluationDetails

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_scope_expand_policy_evaluation_details.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="SUBSCRIPTION_ID",
    )

    response = client.component_policy_states.list_query_results_for_resource(
        resource_id="subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.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 for the resource.
 *
 * @summary Queries component policy states for the resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json
 */
async function queryLatestComponentPolicyStatesAtResourceScopeAndExpandPolicyEvaluationDetails() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster";
  const componentPolicyStatesResource = "latest";
  const filter =
    "componentType eq 'pod' AND componentId eq 'default/test-pod' AND componentName eq 'test-pod'";
  const expand = "PolicyEvaluationDetails";
  const options = {
    filter,
    expand,
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.componentPolicyStates.listQueryResultsForResource(
    resourceId,
    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/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providersMicrosoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "default/test-pod",
      "componentType": "pod",
      "componentName": "test-pod",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster",
      "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.ContainerService/managedClusters",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "Audit Kubernetes policy",
      "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",
      "policyEvaluationDetails": {
        "reason": "tbd reason for evaluation outcome"
      }
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providersMicrosoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
      "componentId": "default/test-pod",
      "componentType": "pod",
      "componentName": "test-pod",
      "timestamp": "2022-04-09T16:04:31Z",
      "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster",
      "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test2",
      "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56",
      "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "resourceType": "/Microsoft.ContainerService/managedClusters",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "test",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
      "policyDefinitionName": "Audit Kubernetes policy",
      "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",
      "policyEvaluationDetails": {
        "reason": "tbd reason for evaluation outcome"
      }
    }
  ]
}

Définitions

Nom	Description
ComponentExpressionEvaluationDetails	Détails de l’évaluation des expressions de langage de stratégie.
ComponentPolicyEvaluationDetails	Détails de l’évaluation de la stratégie.
ComponentPolicyState	Enregistrement d’état de la stratégie de composant.
ComponentPolicyStatesQueryResults	Résultats de la requête.
ComponentPolicyStatesResource	Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant.
ErrorDefinition	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
TypedErrorInfo	Détails de l’erreur spécifique au scénario.

ComponentExpressionEvaluationDetails

Détails de l’évaluation des expressions de langage de stratégie.

Nom	Type	Description
expression	string	Expression évaluée.
expressionKind	string	Type d’expression qui a été évalué.
expressionValue	object	Valeur de l’expression.
operator	string	Opérateur pour comparer la valeur d’expression et la valeur cible.
path	string	Chemin d’accès à la propriété si l’expression est un champ ou un alias.
result	string	Résultat de l’évaluation.
targetValue	object	Valeur cible à comparer à la valeur d’expression.

ComponentPolicyEvaluationDetails

Détails de l’évaluation de la stratégie.

Nom	Type	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Détails des expressions évaluées.
reason	string	Raison textuelle supplémentaire pour le résultat de l’évaluation.

ComponentPolicyState

Enregistrement d’état de la stratégie de composant.

Nom	Type	Description
@odata.context	string	Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.
@odata.id	string	ID d’entité OData ; toujours défini sur null, car les enregistrements d’état de stratégie de composant n’ont pas d’ID d’entité.
complianceState	string	État de conformité de la ressource.
componentId	string	ID du composant.
componentName	string	Nom du composant.
componentType	string	Type de composant.
policyAssignmentId	string	ID d’affectation de stratégie.
policyAssignmentName	string	Nom de l’affectation de stratégie.
policyAssignmentOwner	string	Propriétaire de l’affectation de stratégie.
policyAssignmentParameters	string	Paramètres d’affectation de stratégie.
policyAssignmentScope	string	Étendue de l’affectation de stratégie.
policyAssignmentVersion	string	Version d’affectation de stratégie évaluée.
policyDefinitionAction	string	Action de définition de stratégie, c’est-à-dire effet.
policyDefinitionCategory	string	Catégorie de définition de stratégie.
policyDefinitionGroupNames	string[]	Noms des groupes de définitions de stratégie.
policyDefinitionId	string	ID de définition de stratégie.
policyDefinitionName	string	Nom de la définition de stratégie.
policyDefinitionReferenceId	string	ID de référence pour la définition de stratégie à l’intérieur de l’ensemble de stratégies, si l’affectation de stratégie concerne un ensemble de stratégies.
policyDefinitionVersion	string	Version de définition de stratégie évaluée.
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Détails de l’évaluation de la stratégie. Cela n’est inclus dans la réponse que si la demande contient $expand=PolicyEvaluationDetails.
policySetDefinitionCategory	string	Catégorie de définition d’ensemble de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies.
policySetDefinitionId	string	ID de définition de jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies.
policySetDefinitionName	string	Nom de la définition du jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies.
policySetDefinitionOwner	string	Propriétaire de la définition d’un jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies.
policySetDefinitionParameters	string	Paramètres de définition de jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies.
policySetDefinitionVersion	string	Version de définition d’ensemble de stratégies évaluée.
resourceGroup	string	Nom du groupe de ressources.
resourceId	string	ID de la ressource
resourceLocation	string	Emplacement de la ressource.
resourceType	string	Type de ressource.
subscriptionId	string	l'ID d'abonnement.
timestamp	string	Horodatage de l’enregistrement d’état de la stratégie de composant.

ComponentPolicyStatesQueryResults

Résultats de la requête.

Nom	Type	Description
@odata.context	string	Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.
@odata.count	integer	Nombre d’entités OData ; représente le nombre d’enregistrements d’état de stratégie retournés.
value	ComponentPolicyState[]	Résultats de la requête.

ComponentPolicyStatesResource

Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant.

Nom	Type	Description
latest	string

ErrorDefinition

Définition de l’erreur.

Nom	Type	Description
additionalInfo	TypedErrorInfo[]	Détails d’erreur supplémentaires spécifiques au scénario.
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	ErrorDefinition[]	Détails de l’erreur interne.
message	string	Description de l'erreur.
target	string	Cible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	ErrorDefinition	Détails de l’erreur.

TypedErrorInfo

Détails de l’erreur spécifique au scénario.

Nom	Type	Description
info		Détails de l’erreur spécifique au scénario.
type	string	Type de détails d’erreur inclus.