Component Policy States - List Query Results For Subscription

Service:

Policy

API-versie:

2022-04-01

Query's voor onderdeelbeleidsstatussen onder abonnementsbereik.

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

Met optionele 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}

URI-parameters

Name	In	Vereist	Type	Description
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	De virtuele resource onder Resourcetype ComponentPolicyStates. In een bepaald tijdsbereik staat 'nieuwste' voor de meest recente onderdeelbeleidsstatus(s).
subscriptionId	path	True	string	Microsoft Azure-abonnements-id.
api-version	query	True	string	Client-API-versie.
$apply	query		string	OData-expressie toepassen voor aggregaties.
$filter	query		string	OData-filterexpressie.
$from	query		string date-time	Tijdstempel met ISO 8601-indeling die de begintijd aangeeft van het interval om een query uit te voeren. Wanneer deze niet is opgegeven, gebruikt de service ($to - 1 dag).
$orderby	query		string	De expressie ordenen met behulp van de OData-notatie. Een of meer door komma's gescheiden kolomnamen met een optionele 'desc' (de standaardinstelling) of 'asc', bijvoorbeeld '$orderby=PolicyAssignmentId, ResourceId asc'.
$select	query		string	Selecteer de expressie met behulp van de OData-notatie. Beperkt de kolommen voor elke record tot alleen de kolommen die zijn aangevraagd, bijvoorbeeld '$select=PolicyAssignmentId, ResourceId'.
$to	query		string date-time	Tijdstempel met ISO 8601-indeling die de eindtijd aangeeft van het interval dat moet worden opgevraagd. Wanneer deze niet is opgegeven, gebruikt de service aanvraagtijd.
$top	query		integer int32	Maximum aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	ComponentPolicyStatesQueryResults	Queryresultaten.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
ComponentExpressionEvaluationDetails	Evaluatiedetails van beleidstaalexpressies.
ComponentPolicyEvaluationDetails	Details van beleidsevaluatie.
ComponentPolicyState	Statusrecord van onderdeelbeleid.
ComponentPolicyStatesQueryResults	Queryresultaten.
ComponentPolicyStatesResource	De virtuele resource onder Resourcetype ComponentPolicyStates. In een bepaald tijdsbereik staat 'nieuwste' voor de meest recente onderdeelbeleidsstatus(s).
ErrorDefinition	Foutdefinitie.
ErrorResponse	Foutreactie.
TypedErrorInfo	Scenariospecifieke foutdetails.

ComponentExpressionEvaluationDetails

Evaluatiedetails van beleidstaalexpressies.

Name	Type	Description
expression	string	Expressie geëvalueerd.
expressionKind	string	Het type expressie dat is geëvalueerd.
expressionValue	object	Waarde van de expressie.
operator	string	Operator om de expressiewaarde en de doelwaarde te vergelijken.
path	string	Eigenschapspad als de expressie een veld of een alias is.
result	string	Evaluatieresultaat.
targetValue	object	Doelwaarde die moet worden vergeleken met de expressiewaarde.

ComponentPolicyEvaluationDetails

Details van beleidsevaluatie.

Name	Type	Description
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Details van de geëvalueerde expressies.
reason	string	Aanvullende tekstreden voor het evaluatieresultaat.

ComponentPolicyState

Statusrecord van onderdeelbeleid.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.id	string	OData-entiteits-id; altijd ingesteld op null omdat de statusrecords van het onderdeelbeleid geen entiteits-id hebben.
complianceState	string	Nalevingsstatus van de resource.
componentId	string	Onderdeel-id.
componentName	string	Onderdeelnaam.
componentType	string	Onderdeeltype.
policyAssignmentId	string	Beleidstoewijzings-id.
policyAssignmentName	string	Naam van beleidstoewijzing.
policyAssignmentOwner	string	Eigenaar van beleidstoewijzing.
policyAssignmentParameters	string	Parameters voor beleidstoewijzing.
policyAssignmentScope	string	Bereik van beleidstoewijzing.
policyAssignmentVersion	string	Geëvalueerde versie van beleidstoewijzing.
policyDefinitionAction	string	Beleidsdefinitieactie, dat wil zeggen effect.
policyDefinitionCategory	string	Beleidsdefinitiecategorie.
policyDefinitionGroupNames	string[]	Namen van beleidsdefinitiegroepen.
policyDefinitionId	string	Beleidsdefinitie-id.
policyDefinitionName	string	Naam van beleidsdefinitie.
policyDefinitionReferenceId	string	Referentie-id voor de beleidsdefinitie in de beleidsset, als de beleidstoewijzing voor een beleidsset is.
policyDefinitionVersion	string	Geëvalueerde beleidsdefinitieversie.
policyEvaluationDetails	ComponentPolicyEvaluationDetails	Details van beleidsevaluatie. Dit wordt alleen opgenomen in het antwoord als de aanvraag $expand=PolicyEvaluationDetails bevat.
policySetDefinitionCategory	string	Definitiecategorie van de beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionId	string	Definitie-id van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionName	string	Definitienaam van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionOwner	string	Eigenaar van de beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionParameters	string	Parameters voor beleidssetdefinities, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionVersion	string	Geëvalueerde versie van de definitie van de beleidsset.
resourceGroup	string	Naam van de resourcegroep.
resourceId	string	Resource-id.
resourceLocation	string	Resourcelocatie.
resourceType	string	Resourcetype.
subscriptionId	string	Abonnements-id.
timestamp	string	Tijdstempel voor de statusrecord van het onderdeelbeleid.

ComponentPolicyStatesQueryResults

Queryresultaten.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.count	integer	Aantal OData-entiteiten; vertegenwoordigt het aantal geretourneerde beleidsstatusrecords.
value	ComponentPolicyState[]	Queryresultaten.

ComponentPolicyStatesResource

De virtuele resource onder Resourcetype ComponentPolicyStates. In een bepaald tijdsbereik staat 'nieuwste' voor de meest recente onderdeelbeleidsstatus(s).

Name	Type	Description
latest	string

ErrorDefinition

Foutdefinitie.

Name	Type	Description
additionalInfo	TypedErrorInfo[]	Aanvullende scenariospecifieke foutdetails.
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	ErrorDefinition[]	Interne foutdetails.
message	string	Beschrijving van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	ErrorDefinition	De foutdetails.

TypedErrorInfo

Scenariospecifieke foutdetails.

Name	Type	Description
info		De specifieke foutdetails van het scenario.
type	string	Het type opgenomen foutdetails.