Policy States - Summarize For Policy Set Definition

Referenz

Dienst:: Policy

API-Version:: 2019-10-01

Fasst Richtlinienzustände für die Richtliniensatzdefinition auf Abonnementebene zusammen.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01

Mit optionalen Parametern:

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationNamespace	path	True	AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
policySetDefinitionName	path	True	string	Richtliniensatzdefinitionsname.
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates" zur Zusammenfassung der Aktion. In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.
subscriptionId	path	True	string	Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Client-API-Version.
$filter	query		string	OData-Filterausdruck.
$from	query		string (date-time)	Iso 8601 formatierter Zeitstempel, der die Startzeit des abfrageintervalls angibt. Wenn nicht angegeben, verwendet der Dienst ($to - 1 Tag).
$to	query		string (date-time)	ISO 8601-formatierter Zeitstempel, der die Endzeit des abzufragenden Intervalls angibt. Wenn nicht angegeben, verwendet der Dienst die Anforderungszeit.
$top	query		integer (int32) minimum: 0	Maximale Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	SummarizeResults	Zusammenfassung der Ergebnisse.
Other Status Codes	QueryFailure	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Summarize at policy set definition scope

Beispielanforderung

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=1&$from=2019-10-05T18:00:00Z&$to=2019-10-06T18:00:00Z&$filter=PolicyDefinitionAction eq 'deny'


import com.azure.resourcemanager.policyinsights.models.PolicyStatesSummaryResourceType;
import java.time.OffsetDateTime;

/**
 * Samples for PolicyStates SummarizeForPolicySetDefinition.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/
     * PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
     */
    /**
     * Sample code: Summarize at policy set definition scope.
     * 
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void
        summarizeAtPolicySetDefinitionScope(com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.policyStates().summarizeForPolicySetDefinitionWithResponse(PolicyStatesSummaryResourceType.LATEST,
            "fffedd8f-ffff-fffd-fffd-fffed2f84852", "3e3807c1-65c9-49e0-a406-82d8ae3e338c", 1,
            OffsetDateTime.parse("2019-10-05T18:00:00Z"), OffsetDateTime.parse("2019-10-06T18:00:00Z"),
            "PolicyDefinitionAction eq 'deny'", com.azure.core.util.Context.NONE);
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python policy_states_summarize_subscription_level_policy_set_definition_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.policy_states.summarize_for_policy_set_definition(
        policy_states_summary_resource="latest",
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        policy_set_definition_name="3e3807c1-65c9-49e0-a406-82d8ae3e338c",
    )
    print(response)


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

package armpolicyinsights_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/policyinsights/armpolicyinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05a9cdab363b8ec824094ee73950c04594325172/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
func ExamplePolicyStatesClient_SummarizeForPolicySetDefinition() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicyinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicyStatesClient().SummarizeForPolicySetDefinition(ctx, armpolicyinsights.PolicyStatesSummaryResourceTypeLatest, "fffedd8f-ffff-fffd-fffd-fffed2f84852", "3e3807c1-65c9-49e0-a406-82d8ae3e338c", &armpolicyinsights.QueryOptions{Top: to.Ptr[int32](1),
		Filter:    to.Ptr("PolicyDefinitionAction eq 'deny'"),
		OrderBy:   nil,
		Select:    nil,
		From:      to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-05T18:00:00.000Z"); return t }()),
		To:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-06T18:00:00.000Z"); return t }()),
		Apply:     nil,
		SkipToken: nil,
		Expand:    nil,
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SummarizeResults = armpolicyinsights.SummarizeResults{
	// 	ODataContext: to.Ptr("https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary"),
	// 	ODataCount: to.Ptr[int32](1),
	// 	Value: []*armpolicyinsights.Summary{
	// 		{
	// 			ODataContext: to.Ptr("https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity"),
	// 			PolicyAssignments: []*armpolicyinsights.PolicyAssignmentSummary{
	// 			},
	// 			Results: &armpolicyinsights.SummaryResults{
	// 				NonCompliantPolicies: to.Ptr[int32](0),
	// 				NonCompliantResources: to.Ptr[int32](0),
	// 				PolicyDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](1),
	// 				}},
	// 				PolicyGroupDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](1),
	// 				}},
	// 				QueryResultsURI: to.Ptr("https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny') and IsCompliant eq false"),
	// 				ResourceDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](140),
	// 				}},
	// 			},
	// 	}},
	// }
}

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 Summarizes policy states for the subscription level policy set definition.
 *
 * @summary Summarizes policy states for the subscription level policy set definition.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
 */
async function summarizeAtPolicySetDefinitionScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const policyStatesSummaryResource = "latest";

  const policySetDefinitionName = "3e3807c1-65c9-49e0-a406-82d8ae3e338c";
  const top = 1;
  const fromParam = new Date("2019-10-05T18:00:00Z");
  const to = new Date("2019-10-06T18:00:00Z");
  const filter = "PolicyDefinitionAction eq 'deny'";
  const options = {
    queryOptions: { top: top, to: to, from: fromParam, filter: filter },
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.policyStates.summarizeForPolicySetDefinition(
    policyStatesSummaryResource,
    subscriptionId,
    policySetDefinitionName,
    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

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny') and IsCompliant eq false",
        "nonCompliantResources": 0,
        "nonCompliantPolicies": 0,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 140
          }
        ],
        "policyDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ]
      },
      "policyAssignments": []
    }
  ]
}

Definitionen

Name	Beschreibung
AuthorizationNamespaceType	Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
ComplianceDetail	Das Rollup des Compliancestatus.
Error	Fehlerdefinition.
PolicyAssignmentSummary	Zusammenfassung der Richtlinienzuweisung.
PolicyDefinitionSummary	Zusammenfassung der Richtliniendefinition.
PolicyGroupSummary	Zusammenfassung der Richtliniendefinitionsgruppe.
PolicyStatesSummaryResourceType	Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates" zur Zusammenfassung der Aktion. In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.
QueryFailure	Fehlerantwort.
SummarizeResults	Zusammenfassung der Aktionsergebnisse.
Summary	Zusammenfassungsergebnisse.
SummaryResults	Compliancezusammenfassung auf einer bestimmten Zusammenfassungsebene.

AuthorizationNamespaceType

Enumeration

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

Wert	Beschreibung
Microsoft.Authorization

ComplianceDetail

Objekt

Das Rollup des Compliancestatus.

Name	Typ	Beschreibung
complianceState	string	Der Konformitätsstatus.
count	integer (int32)	Zusammengefasster Zählerwert für diesen Compliancestatus.

Error

Objekt

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
message	string	Beschreibung des Fehlers.

PolicyAssignmentSummary

Objekt

Zusammenfassung der Richtlinienzuweisung.

Name	Typ	Beschreibung
policyAssignmentId	string	Richtlinienzuweisungs-ID.
policyDefinitions	PolicyDefinitionSummary[]	Zusammenfassung der Richtliniendefinitionen.
policyGroups	PolicyGroupSummary[]	Zusammenfassung der Richtliniendefinitionsgruppe.
policySetDefinitionId	string	Richtliniensatzdefinitions-ID, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt.
results	SummaryResults	Compliancezusammenfassung für die Richtlinienzuweisung.

PolicyDefinitionSummary

Objekt

Zusammenfassung der Richtliniendefinition.

Name	Typ	Beschreibung
effect	string	Richtlinieneffekt, d. h. Richtliniendefinitionsaktion.
policyDefinitionGroupNames	string[]	Gruppennamen für Richtliniendefinitionen.
policyDefinitionId	string	Richtliniendefinitions-ID.
policyDefinitionReferenceId	string	Richtliniendefinitionsreferenz-ID.
results	SummaryResults	Compliancezusammenfassung für die Richtliniendefinition.

PolicyGroupSummary

Objekt

Zusammenfassung der Richtliniendefinitionsgruppe.

Name	Typ	Beschreibung
policyGroupName	string	Name der Richtliniengruppe.
results	SummaryResults	Compliancezusammenfassung für die Richtliniendefinitionsgruppe.

PolicyStatesSummaryResourceType

Enumeration

Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates" zur Zusammenfassung der Aktion. In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.

Wert	Beschreibung
latest

QueryFailure

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlerdefinition.

SummarizeResults

Objekt

Zusammenfassung der Aktionsergebnisse.

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.count	integer (int32) minimum: 1 maximum: 1	OData-Entitätsanzahl; stellt die Anzahl der zurückgegebenen Zusammenfassungen dar; immer auf 1 festgelegt.
value	Summary[]	Zusammenfassung der Aktionsergebnisse.

Summary

Objekt

Zusammenfassungsergebnisse.

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.id	string	OData-Entitäts-ID; immer auf NULL festgelegt, da Zusammenfassungen keine Entitäts-ID aufweisen.
policyAssignments	PolicyAssignmentSummary[]	Zusammenfassung der Richtlinienzuweisungen.
results	SummaryResults	Compliancezusammenfassung für alle Richtlinienzuweisungen.

SummaryResults

Objekt

Compliancezusammenfassung auf einer bestimmten Zusammenfassungsebene.

Name	Typ	Beschreibung
nonCompliantPolicies	integer (int32) minimum: 0	Anzahl nicht konformer Richtlinien.
nonCompliantResources	integer (int32) minimum: 0	Anzahl nicht kompatibler Ressourcen.
policyDetails	ComplianceDetail[]	Die Zusammenfassung des Richtlinienartefaktes auf dieser Ebene. Für die Abfragebereichsebene stellt sie eine Richtlinienzuweisungszusammenfassung dar. Für die Richtlinienzuweisungsebene stellt sie eine Zusammenfassung der Richtliniendefinitionen dar.
policyGroupDetails	ComplianceDetail[]	Die Gruppenzusammenfassung der Richtliniendefinitionsgruppe auf dieser Ebene.
queryResultsUri	string	HTTP POST-URI für queryResults-Aktion in Microsoft.PolicyInsights zum Abrufen von Rohergebnissen für die Compliancezusammenfassung. Diese Eigenschaft ist in zukünftigen API-Versionen nicht standardmäßig verfügbar, kann jedoch explizit abgefragt werden.
resourceDetails	ComplianceDetail[]	Die Ressourcenzusammenfassung auf dieser Ebene.

Freigeben über

Policy States - Summarize For Policy Set Definition

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Summarize at policy set definition scope

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AuthorizationNamespaceType

ComplianceDetail

Error

PolicyAssignmentSummary

PolicyDefinitionSummary

PolicyGroupSummary

PolicyStatesSummaryResourceType

QueryFailure

SummarizeResults

Summary

SummaryResults