Policy States - Summarize For Management Group

Service:

Policy

API Version:

2019-10-01

Fasst richtlinienstatus für die Ressourcen unter der Verwaltungsgruppe zusammen.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01

With optional parameters:

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/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
managementGroupName	path	True	string	Name der Verwaltungsgruppe.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Der Namespace für Microsoft-Verwaltungs-RP; nur "Microsoft.Management" ist zulässig.
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	Die virtuelle Ressource unter dem Ressourcentyp PolicyStates für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.
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 abzufragenden Intervalls 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 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	SummarizeResults	Fassen Sie die Ergebnisse zusammen.
Other Status Codes	QueryFailure	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

Summarize at management group scope

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=0&$from=2019-10-05T18:00:00Z&$to=2019-10-06T18:00:00Z&$filter=PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'

Java

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

/** Samples for PolicyStates SummarizeForManagementGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json
     */
    /**
     * Sample code: Summarize at management group scope.
     *
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void summarizeAtManagementGroupScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager
            .policyStates()
            .summarizeForManagementGroupWithResponse(
                PolicyStatesSummaryResourceType.LATEST,
                "myManagementGroup",
                0,
                OffsetDateTime.parse("2019-10-05T18:00:00Z"),
                OffsetDateTime.parse("2019-10-06T18:00:00Z"),
                "PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'",
                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

Python

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_management_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="SUBSCRIPTION_ID",
    )

    response = client.policy_states.summarize_for_management_group(
        policy_states_summary_resource="latest",
        management_group_name="myManagementGroup",
    )
    print(response)


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

Go

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_SummarizeManagementGroupScope.json
func ExamplePolicyStatesClient_SummarizeForManagementGroup() {
	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().SummarizeForManagementGroup(ctx, armpolicyinsights.PolicyStatesSummaryResourceTypeLatest, "myManagementGroup", &armpolicyinsights.QueryOptions{Top: to.Ptr[int32](0),
		Filter:    to.Ptr("PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'"),
		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/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary"),
	// 	ODataCount: to.Ptr[int32](1),
	// 	Value: []*armpolicyinsights.Summary{
	// 		{
	// 			ODataContext: to.Ptr("https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity"),
	// 			PolicyAssignments: []*armpolicyinsights.PolicyAssignmentSummary{
	// 			},
	// 			Results: &armpolicyinsights.SummaryResults{
	// 				NonCompliantPolicies: to.Ptr[int32](68),
	// 				NonCompliantResources: to.Ptr[int32](15410),
	// 				PolicyDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("noncompliant"),
	// 						Count: to.Ptr[int32](68),
	// 				}},
	// 				PolicyGroupDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("noncompliant"),
	// 						Count: to.Ptr[int32](14),
	// 				}},
	// 				QueryResultsURI: to.Ptr("https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/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' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false"),
	// 				ResourceDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](1400),
	// 					},
	// 					{
	// 						ComplianceState: to.Ptr("noncompliant"),
	// 						Count: to.Ptr[int32](15410),
	// 				}},
	// 			},
	// 	}},
	// }
}

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 Summarizes policy states for the resources under the management group.
 *
 * @summary Summarizes policy states for the resources under the management group.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json
 */
async function summarizeAtManagementGroupScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const policyStatesSummaryResource = "latest";
  const managementGroupName = "myManagementGroup";
  const top = 0;
  const fromParam = new Date("2019-10-05T18:00:00Z");
  const to = new Date("2019-10-06T18:00:00Z");
  const filter = "PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'";
  const options = {
    queryOptions: { top: top, from: fromParam, to: to, filter: filter },
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.policyStates.summarizeForManagementGroup(
    policyStatesSummaryResource,
    managementGroupName,
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ManagementGroups;
using Azure.ResourceManager.PolicyInsights;
using Azure.ResourceManager.PolicyInsights.Models;

// Generated from example definition: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json
// this example is just showing the usage of "PolicyStates_SummarizeForManagementGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagementGroupResource created on azure
// for more information of creating ManagementGroupResource, please refer to the document of ManagementGroupResource
string managementGroupName = "myManagementGroup";
ResourceIdentifier managementGroupResourceId = ManagementGroupResource.CreateResourceIdentifier(managementGroupName);
ManagementGroupResource managementGroupResource = client.GetManagementGroupResource(managementGroupResourceId);

// invoke the operation and iterate over the result
PolicyStateSummaryType policyStateSummaryType = PolicyStateSummaryType.Latest;
await foreach (PolicySummary item in managementGroupResource.SummarizePolicyStatesAsync(policyStateSummaryType))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/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' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false",
        "nonCompliantResources": 15410,
        "nonCompliantPolicies": 68,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 1400
          },
          {
            "complianceState": "noncompliant",
            "count": 15410
          }
        ],
        "policyDetails": [
          {
            "complianceState": "noncompliant",
            "count": 68
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "noncompliant",
            "count": 14
          }
        ]
      },
      "policyAssignments": []
    }
  ]
}

Definitionen

Name	Beschreibung
ComplianceDetail	Das Rollup für den Konformitätszustand.
Error	Fehlerdefinition.
ManagementGroupsNamespaceType	Der Namespace für Microsoft-Verwaltungs-RP; nur "Microsoft.Management" ist zulässig.
PolicyAssignmentSummary	Zusammenfassung der Richtlinienzuweisung.
PolicyDefinitionSummary	Zusammenfassung der Richtliniendefinition.
PolicyGroupSummary	Zusammenfassung der Richtliniendefinitionsgruppe.
PolicyStatesSummaryResourceType	Die virtuelle Ressource unter dem Ressourcentyp PolicyStates für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.
QueryFailure	Fehlerantwort.
SummarizeResults	Zusammenfassen von Aktionsergebnissen
Summary	Zusammenfassungsergebnisse.
SummaryResults	Konformitätszusammenfassung auf einer bestimmten Zusammenfassungsebene.

ComplianceDetail

Das Rollup für den Konformitätszustand.

Name	Typ	Beschreibung
complianceState	string	Der Kompatibilitätsstatus.
count	integer	Zusammengefasster Zählerwert für diesen Konformitätszustand.

Error

Fehlerdefinition.

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

ManagementGroupsNamespaceType

Der Namespace für Microsoft-Verwaltungs-RP; nur "Microsoft.Management" ist zulässig.

Name	Typ	Beschreibung
Microsoft.Management	string

PolicyAssignmentSummary

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	Konformitätszusammenfassung für die Richtlinienzuweisung.

PolicyDefinitionSummary

Zusammenfassung der Richtliniendefinition.

Name	Typ	Beschreibung
effect	string	Richtlinieneffekt, d. h. Richtliniendefinitionsaktion.
policyDefinitionGroupNames	string[]	Namen von Richtliniendefinitionsgruppen.
policyDefinitionId	string	Richtliniendefinitions-ID.
policyDefinitionReferenceId	string	Referenz-ID der Richtliniendefinition.
results	SummaryResults	Konformitätszusammenfassung für die Richtliniendefinition.

PolicyGroupSummary

Zusammenfassung der Richtliniendefinitionsgruppe.

Name	Typ	Beschreibung
policyGroupName	string	Name der Richtliniengruppe.
results	SummaryResults	Konformitätszusammenfassung für die Richtliniendefinitionsgruppe.

PolicyStatesSummaryResourceType

Die virtuelle Ressource unter dem Ressourcentyp PolicyStates für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.

Name	Typ	Beschreibung
latest	string

QueryFailure

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlerdefinition.

SummarizeResults

Zusammenfassen von Aktionsergebnissen

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.count	integer	Anzahl der OData-Entitäten; stellt die Anzahl der zurückgegebenen Zusammenfassungen dar; immer auf 1 festgelegt.
value	Summary[]	Zusammenfassen von Aktionsergebnissen

Summary

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	Konformitätszusammenfassung für alle Richtlinienzuweisungen.

SummaryResults

Konformitätszusammenfassung auf einer bestimmten Zusammenfassungsebene.

Name	Typ	Beschreibung
nonCompliantPolicies	integer	Anzahl der nicht konformen Richtlinien.
nonCompliantResources	integer	Anzahl der nicht konformen Ressourcen.
policyDetails	ComplianceDetail[]	Die Zusammenfassung des Richtlinienartefakts auf dieser Ebene. Für Abfragebereichsebene stellt sie eine Zusammenfassung der Richtlinienzuweisung dar. Für die Richtlinienzuweisungsebene stellt sie die Zusammenfassung von Richtliniendefinitionen dar.
policyGroupDetails	ComplianceDetail[]	Die Zusammenfassung der Richtliniendefinitionsgruppe auf dieser Ebene.
queryResultsUri	string	HTTP POST URI für queryResults-Aktion in Microsoft.PolicyInsights zum Abrufen von Rohergebnissen für die Konformitätszusammenfassung. Diese Eigenschaft ist in zukünftigen API-Versionen standardmäßig nicht verfügbar, kann aber explizit abgefragt werden.
resourceDetails	ComplianceDetail[]	Die Ressourcenzusammenfassung auf dieser Ebene.