Component Policy States - List Query Results For Subscription

Service:

Policy

API Version:

2022-04-01

Dotazuje stavy zásad komponent v rozsahu předplatného.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	Virtuální prostředek v části Typ prostředku ComponentPolicyStates V daném časovém rozsahu představuje nejnovější stav zásad komponent.
subscriptionId	path	True	string	ID předplatného Microsoft Azure.
api-version	query	True	string	Verze rozhraní API klienta.
$apply	query		string	Použití výrazu OData pro agregace
$filter	query		string	Výraz filtru OData.
$from	query		string date-time	Časové razítko ve formátu ISO 8601 určující počáteční čas intervalu, který se má dotazovat. Pokud není zadaný, služba použije ($to - 1 den).
$orderby	query		string	Výraz řazení pomocí notace OData. Jeden nebo více názvů sloupců oddělených čárkami s volitelným "desc" (výchozí) nebo "asc", např. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Select expression using OData notation.Select expression using OData notation. Omezí sloupce v každém záznamu jenom na požadované položky, například "$select=PolicyAssignmentId, ResourceId".
$to	query		string date-time	Časové razítko ve formátu ISO 8601 určující koncový čas intervalu, který se má dotazovat. Pokud není zadaný, služba použije čas požadavku.
$top	query		integer int32	Maximální počet záznamů, které se mají vrátit.

Odpovědi

Name	Typ	Description
200 OK	ComponentPolicyStatesQueryResults	Výsledky dotazu.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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"
    }
  ]
}

Definice

Name	Description
ComponentExpressionEvaluationDetails	Podrobnosti vyhodnocení výrazů jazyka zásad
ComponentPolicyEvaluationDetails	Podrobnosti o vyhodnocení zásad
ComponentPolicyState	Záznam stavu zásad komponenty.
ComponentPolicyStatesQueryResults	Výsledky dotazu.
ComponentPolicyStatesResource	Virtuální prostředek v části Typ prostředku ComponentPolicyStates V daném časovém rozsahu představuje nejnovější stav zásad komponent.
ErrorDefinition	Definice chyby.
ErrorResponse	Chybová odpověď.
TypedErrorInfo	Podrobnosti o chybách specifických pro scénář

ComponentExpressionEvaluationDetails

Podrobnosti vyhodnocení výrazů jazyka zásad

Name	Typ	Description
expression	string	Výraz byl vyhodnocen.
expressionKind	string	Druh výrazu, který byl vyhodnocen.
expressionValue	object	Hodnota výrazu
operator	string	Operátor pro porovnání hodnoty výrazu a cílové hodnoty.
path	string	Cesta k vlastnosti, pokud je výraz pole nebo alias.
result	string	Výsledek vyhodnocení.
targetValue	object	Cílová hodnota, která se má porovnat s hodnotou výrazu.

ComponentPolicyEvaluationDetails

Podrobnosti o vyhodnocení zásad

Name	Typ	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Podrobnosti o vyhodnocených výrazech
reason	string	Další textový důvod pro výsledek vyhodnocení.

ComponentPolicyState

Záznam stavu zásad komponenty.

Name	Typ	Description
@odata.context	string	Kontextový řetězec OData; používá klienty OData k překladu informací o typu na základě metadat.
@odata.id	string	ID entity OData; Vlastnost vždy nastavená na hodnotu null, protože záznamy o stavu zásad součástí nemají ID entity.
complianceState	string	Stav dodržování předpisů prostředku.
componentId	string	ID komponenty.
componentName	string	Název komponenty.
componentType	string	Typ komponenty.
policyAssignmentId	string	ID přiřazení zásad.
policyAssignmentName	string	Název přiřazení zásad.
policyAssignmentOwner	string	Vlastník přiřazení zásad.
policyAssignmentParameters	string	Parametry přiřazení zásad.
policyAssignmentScope	string	Obor přiřazení zásad.
policyAssignmentVersion	string	Vyhodnocená verze přiřazení zásad
policyDefinitionAction	string	Akce definice zásad, tj. účinek.
policyDefinitionCategory	string	Kategorie definice zásad
policyDefinitionGroupNames	string[]	Názvy skupin definic zásad.
policyDefinitionId	string	ID definice zásady.
policyDefinitionName	string	Název definice zásad.
policyDefinitionReferenceId	string	Referenční ID pro definici zásady uvnitř sady zásad, pokud je přiřazení zásady pro sadu zásad.
policyDefinitionVersion	string	Vyhodnocená verze definice zásad
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Podrobnosti o vyhodnocení zásad To je součástí odpovědi pouze v případě, že požadavek obsahuje $expand=PolicyEvaluationDetails.
policySetDefinitionCategory	string	Kategorie definice sady zásad, pokud je přiřazení zásad pro sadu zásad.
policySetDefinitionId	string	ID definice sady zásad, pokud je přiřazení zásady určené pro sadu zásad.
policySetDefinitionName	string	Název definice sady zásad, pokud je přiřazení zásad pro sadu zásad.
policySetDefinitionOwner	string	Vlastník definice sady zásad, pokud je přiřazení zásad pro sadu zásad.
policySetDefinitionParameters	string	Parametry definice sady zásad, pokud je přiřazení zásad pro sadu zásad.
policySetDefinitionVersion	string	Vyhodnocená verze definice sady zásad
resourceGroup	string	Název skupiny prostředků.
resourceId	string	ID prostředku.
resourceLocation	string	Umístění prostředku.
resourceType	string	Typ prostředku.
subscriptionId	string	ID předplatného
timestamp	string	Časové razítko záznamu o stavu zásad komponenty.

ComponentPolicyStatesQueryResults

Výsledky dotazu.

Name	Typ	Description
@odata.context	string	Kontextový řetězec OData; používá klienty OData k překladu informací o typu na základě metadat.
@odata.count	integer	Počet entit OData; představuje počet vrácených záznamů o stavu zásad.
value	ComponentPolicyState[]	Výsledky dotazu.

ComponentPolicyStatesResource

Virtuální prostředek v části Typ prostředku ComponentPolicyStates V daném časovém rozsahu představuje nejnovější stav zásad komponent.

Name	Typ	Description
latest	string

ErrorDefinition

Definice chyby.

Name	Typ	Description
additionalInfo	TypedErrorInfo[]	Další podrobnosti o chybách specifických pro scénář
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav pro kód chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď.

Name	Typ	Description
error	ErrorDefinition	Podrobnosti o chybě.

TypedErrorInfo

Podrobnosti o chybách specifických pro scénář

Name	Typ	Description
info		Podrobnosti o chybách specifických pro scénář
type	string	Typ zahrnutých podrobností o chybě.