Component Policy States - List Query Results For Subscription Level Policy Assignment

Referenz

Service:: Policy

API Version:: 2022-04-01

Fragt komponentenrichtlinienstatus für die Richtlinienzuweisung auf Abonnementebene ab.

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

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationNamespace	path	True	AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
componentPolicyStatesResource	path	True	ComponentPolicyStatesResource	Die virtuelle Ressource unter dem Ressourcentyp ComponentPolicyStates. In einem bestimmten Zeitbereich stellt "latest" den aktuellen Komponentenrichtlinienstatus dar.
policyAssignmentName	path	True	string	Name der Richtlinienzuweisung. Regex pattern: `^[^<>%&:\\?/#]*$`
subscriptionId	path	True	string	Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Client-API-Version.
$apply	query		string	OData apply-Ausdruck für Aggregationen.
$filter	query		string	OData-Filterausdruck.
$from	query		string date-time	Iso 8601 formatierter Zeitstempel, der die Startzeit des abzufragenden Intervalls angibt. Wenn nicht angegeben, verwendet der Dienst ($to - 1-Tag).
$orderby	query		string	Sortieren eines Ausdrucks mithilfe der OData-Notation. Ein oder mehrere durch Trennzeichen getrennte Spaltennamen mit einem optionalen "desc" (Standard) oder "asc", z. B. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Wählen Sie den Ausdruck mithilfe der OData-Notation aus. Beschränkt die Spalten für jeden Datensatz auf die angeforderten, z. B. "$select=PolicyAssignmentId, ResourceId".
$to	query		string date-time	Iso 8601 formatierter Zeitstempel, der die Endzeit des abzufragenden Intervalls angibt. Wenn er nicht angegeben ist, verwendet der Dienst die Anforderungszeit.
$top	query		integer int32	Maximale Anzahl von zurückzugebenden Datensätzen.

Antworten

Name	Typ	Beschreibung
200 OK	ComponentPolicyStatesQueryResults	Abfrageergebnisse.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Query latest at subscription level policy assignment scope

Sample Request

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01

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_level_policy_assignment_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_subscription_level_policy_assignment(
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        policy_assignment_name="ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
        component_policy_states_resource="latest",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.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

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

/**
 * This sample demonstrates how to Queries component policy states for the subscription level policy assignment.
 *
 * @summary Queries component policy states for the subscription level policy assignment.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-04-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json
 */
async function queryLatestAtSubscriptionLevelPolicyAssignmentScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const policyAssignmentName = "ec8f9645-8ecb-4abb-9c0b-5292f19d4003";
  const componentPolicyStatesResource = "latest";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result =
    await client.componentPolicyStates.listQueryResultsForSubscriptionLevelPolicyAssignment(
      subscriptionId,
      policyAssignmentName,
      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/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474",
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": "2124621540977569058",
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/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/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.KeyVault/vaults",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "policyDefinitionReferenceId": "14799174781370023846",
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Definitionen

Name	Beschreibung
AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
ComponentExpressionEvaluationDetails	Auswertungsdetails von Richtliniensprachausdrücken.
ComponentPolicyEvaluationDetails	Details zur Richtlinienauswertung.
ComponentPolicyState	Komponentenrichtlinienstatusdatensatz.
ComponentPolicyStatesQueryResults	Abfrageergebnisse.
ComponentPolicyStatesResource	Die virtuelle Ressource unter dem Ressourcentyp ComponentPolicyStates. In einem bestimmten Zeitbereich stellt "latest" den aktuellen Komponentenrichtlinienstatus dar.
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
TypedErrorInfo	Szenariospezifische Fehlerdetails.

AuthorizationNamespaceType

Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.

Name	Typ	Beschreibung
Microsoft.Authorization	string

ComponentExpressionEvaluationDetails

Auswertungsdetails von Richtliniensprachausdrücken.

Name	Typ	Beschreibung
expression	string	Ausdruck ausgewertet.
expressionKind	string	Die Art des Ausdrucks, der ausgewertet wurde.
expressionValue	object	Wert des Ausdrucks.
operator	string	Operator zum Vergleichen des Ausdruckswerts und des Zielwerts.
path	string	Eigenschaftspfad, wenn der Ausdruck ein Feld oder ein Alias ist.
result	string	Auswertungsergebnis.
targetValue	object	Zielwert, der mit dem Ausdruckswert verglichen werden soll.

ComponentPolicyEvaluationDetails

Details zur Richtlinienauswertung.

Name	Typ	Beschreibung
evaluatedExpressions	ComponentExpressionEvaluationDetails[]	Details der ausgewerteten Ausdrücke.
reason	string	Zusätzlicher textlicher Grund für das Auswertungsergebnis.