Component Policy States - List Query Results For Resource Group

Service:

Policy

API Version:

2022-04-01

Lekérdezi az összetevőházirend-állapotokat az erőforráscsoport hatókörében.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	A ComponentPolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb összetevőházirend(ek)et jelöli.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Microsoft Azure-előfizetés azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
$apply	query		string	Az OData kifejezéseket alkalmaz az összesítésekhez.
$filter	query		string	OData szűrőkifejezés.
$from	query		string date-time	ISO 8601 formátumú időbélyeg, amely a lekérdezési időköz kezdő időpontját adja meg. Ha nincs megadva, a szolgáltatás ($to - 1 nap) használ.
$orderby	query		string	Kifejezés rendezése OData-jelöléssel. Egy vagy több vesszővel tagolt oszlopnév opcionális "desc" (alapértelmezett) vagy "asc" névvel, például "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Válassza ki a kifejezést OData-jelöléssel. Az egyes rekordok oszlopait csak a kért értékekre korlátozza, például "$select=PolicyAssignmentId, ResourceId".
$to	query		string date-time	ISO 8601 formátumú időbélyeg, amely megadja a lekérdezési időköz befejezési idejét. Ha nincs megadva, a szolgáltatás kérési időt használ.
$top	query		integer int32	A visszaadandó rekordok maximális száma.

Válaszok

Name	Típus	Description
200 OK	ComponentPolicyStatesQueryResults	Lekérdezési eredmények.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Query latest component policy states at resource group scope

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

Sample Request

HTTP

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

Python

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

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

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


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

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


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

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

JavaScript

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

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

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

Sample Response

Status code:

200

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

Query latest component policy states at resource group scope

Sample Request

HTTP

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

Python

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

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

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


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

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


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

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

JavaScript

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

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

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

Sample Response

Status code:

200

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

Definíciók

Name	Description
ComponentExpressionEvaluationDetails	A szabályzatnyelvi kifejezések kiértékelési részletei.
ComponentPolicyEvaluationDetails	Szabályzatértékelés részletei.
ComponentPolicyState	Összetevőházirend-állapotrekord.
ComponentPolicyStatesQueryResults	Lekérdezési eredmények.
ComponentPolicyStatesResource	A ComponentPolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb összetevőházirend(ek)et jelöli.
ErrorDefinition	Hibadefiníció.
ErrorResponse	Hibaválasz.
TypedErrorInfo	Esetspecifikus hiba részletei.

ComponentExpressionEvaluationDetails

A szabályzatnyelvi kifejezések kiértékelési részletei.

Name	Típus	Description
expression	string	Kifejezés kiértékelve.
expressionKind	string	A kiértékelt kifejezés típusa.
expressionValue	object	A kifejezés értéke.
operator	string	Operátor a kifejezésérték és a célérték összehasonlításához.
path	string	Tulajdonság elérési útja, ha a kifejezés mező vagy alias.
result	string	Kiértékelési eredmény.
targetValue	object	A kifejezés értékével összehasonlítandó célérték.

ComponentPolicyEvaluationDetails

Szabályzatértékelés részletei.

Name	Típus	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	A kiértékelt kifejezések részletei.
reason	string	A kiértékelési eredmény további szöveges oka.

ComponentPolicyState

Összetevőházirend-állapotrekord.

Name	Típus	Description
@odata.context	string	OData környezeti sztring; az OData-ügyfelek használják a típusadatok metaadatokon alapuló feloldására.
@odata.id	string	OData-entitás azonosítója; mindig null értékre van állítva, mivel az összetevőházirend-állapotrekordok nem rendelkeznek entitásazonosítóval.
complianceState	string	Az erőforrás megfelelőségi állapota.
componentId	string	Összetevő azonosítója.
componentName	string	Összetevő neve.
componentType	string	Alkatrésztípus.
policyAssignmentId	string	Szabályzat-hozzárendelés azonosítója.
policyAssignmentName	string	Szabályzat-hozzárendelés neve.
policyAssignmentOwner	string	Szabályzat-hozzárendelés tulajdonosa.
policyAssignmentParameters	string	Szabályzat-hozzárendelési paraméterek.
policyAssignmentScope	string	Szabályzat-hozzárendelés hatóköre.
policyAssignmentVersion	string	A szabályzat-hozzárendelés kiértékelt verziója.
policyDefinitionAction	string	Szabályzatdefiníciós művelet, azaz effektus.
policyDefinitionCategory	string	Szabályzatdefiníciós kategória.
policyDefinitionGroupNames	string[]	Szabályzatdefiníciós csoportnevek.
policyDefinitionId	string	Szabályzatdefiníció azonosítója.
policyDefinitionName	string	Szabályzatdefiníció neve.
policyDefinitionReferenceId	string	A szabályzatkészleten belüli szabályzatdefiníció referencia-azonosítója, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policyDefinitionVersion	string	A szabályzatdefiníció kiértékelt verziója.
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Szabályzatértékelés részletei. Ez csak akkor szerepel a válaszban, ha a kérelem $expand=PolicyEvaluationDetails értéket tartalmaz.
policySetDefinitionCategory	string	Szabályzatkészlet-definíciókategória, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policySetDefinitionId	string	Szabályzatkészlet definícióazonosítója, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policySetDefinitionName	string	Szabályzatkészlet definíciójának neve, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policySetDefinitionOwner	string	Szabályzatkészlet-definíció tulajdonosa, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policySetDefinitionParameters	string	Szabályzatkészlet-definíciós paraméterek, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
policySetDefinitionVersion	string	A szabályzatkészlet definíciójának kiértékelt verziója.
resourceGroup	string	Az erőforráscsoport neve.
resourceId	string	Erőforrás-azonosító.
resourceLocation	string	Erőforrás helye.
resourceType	string	Erőforrástípus.
subscriptionId	string	Előfizetés azonosítója.
timestamp	string	Az összetevőházirend-állapotrekord időbélyege.

ComponentPolicyStatesQueryResults

Lekérdezési eredmények.

Name	Típus	Description
@odata.context	string	OData környezeti sztring; az OData-ügyfelek használják a típusadatok metaadatokon alapuló feloldására.
@odata.count	integer	OData-entitások száma; A visszaadott szabályzatállapotrekordok számát jelöli.
value	ComponentPolicyState[]	Lekérdezési eredmények.

ComponentPolicyStatesResource

A ComponentPolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb összetevőházirend(ek)et jelöli.

Name	Típus	Description
latest	string

ErrorDefinition

Hibadefiníció.

Name	Típus	Description
additionalInfo	TypedErrorInfo[]	További forgatókönyvspecifikus hibaadatok.
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	ErrorDefinition[]	Belső hiba részletei.
message	string	A hiba leírása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	ErrorDefinition	A hiba részletei.

TypedErrorInfo

Esetspecifikus hiba részletei.

Name	Típus	Description
info		A forgatókönyv konkrét hibaadatai.
type	string	A hiba részleteinek típusa.