Policy States - Summarize For Management Group

Service:

Policy

API-versie:

2019-10-01

Geeft een overzicht van beleidsstatussen voor de resources onder de beheergroep.

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

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

Name	In	Vereist	Type	Description
managementGroupName	path	True	string	Naam van beheergroep.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	De naamruimte voor Microsoft Management RP; alleen Microsoft.Management is toegestaan.
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	De virtuele resource onder PolicyStates-resourcetype voor een overzichtsactie. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s) en is dit de enige toegestane waarde.
api-version	query	True	string	Client-API-versie.
$filter	query		string	OData-filterexpressie.
$from	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de begintijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service ($to - 1 dag).
$to	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de eindtijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service de aanvraagtijd.
$top	query		integer (int32) minimum: 0	Maximum aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	SummarizeResults	Resultaten samenvatten.
Other Status Codes	QueryFailure	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

Summarize at management group scope

Voorbeeldaanvraag

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.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'", 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

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ManagementGroups;
using Azure.ResourceManager.PolicyInsights.Models;
using Azure.ResourceManager.PolicyInsights;

// 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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
ComplianceDetail	Het samenvouwen van de nalevingsstatus.
Error	Foutdefinitie.
ManagementGroupsNamespaceType	De naamruimte voor Microsoft Management RP; alleen Microsoft.Management is toegestaan.
PolicyAssignmentSummary	Overzicht van beleidstoewijzing.
PolicyDefinitionSummary	Samenvatting van beleidsdefinities.
PolicyGroupSummary	Samenvatting van beleidsdefinitiegroep.
PolicyStatesSummaryResourceType	De virtuele resource onder PolicyStates-resourcetype voor een overzichtsactie. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s) en is dit de enige toegestane waarde.
QueryFailure	Foutreactie.
SummarizeResults	Actieresultaten samenvatten.
Summary	Samenvattingsresultaten.
SummaryResults	Nalevingsoverzicht op een bepaald overzichtsniveau.

ComplianceDetail

Object

Het samenvouwen van de nalevingsstatus.

Name	Type	Description
complianceState	string	De nalevingsstatus.
count	integer (int32)	Samengevatte tellingswaarde voor deze nalevingsstatus.

Error

Object

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
message	string	Beschrijving van de fout.

ManagementGroupsNamespaceType

Inventarisatie

De naamruimte voor Microsoft Management RP; alleen Microsoft.Management is toegestaan.

Waarde	Description
Microsoft.Management

PolicyAssignmentSummary

Object

Overzicht van beleidstoewijzing.

Name	Type	Description
policyAssignmentId	string	Id van beleidstoewijzing.
policyDefinitions	PolicyDefinitionSummary[]	Overzicht van beleidsdefinities.
policyGroups	PolicyGroupSummary[]	Samenvatting van beleidsdefinitiegroep.
policySetDefinitionId	string	Definitie-id van beleidsset, als de beleidstoewijzing voor een beleidsset is.
results	SummaryResults	Nalevingsoverzicht voor de beleidstoewijzing.

PolicyDefinitionSummary

Object

Samenvatting van beleidsdefinities.

Name	Type	Description
effect	string	Beleidseffect, bijvoorbeeld actie voor beleidsdefinities.
policyDefinitionGroupNames	string[]	Namen van beleidsdefinitiegroepen.
policyDefinitionId	string	Id van beleidsdefinitie.
policyDefinitionReferenceId	string	Referentie-id voor beleidsdefinities.
results	SummaryResults	Nalevingsoverzicht voor de beleidsdefinitie.

PolicyGroupSummary

Object

Samenvatting van beleidsdefinitiegroep.

Name	Type	Description
policyGroupName	string	Naam van beleidsgroep.
results	SummaryResults	Overzicht van naleving voor de beleidsdefinitiegroep.

PolicyStatesSummaryResourceType

Inventarisatie

De virtuele resource onder PolicyStates-resourcetype voor een overzichtsactie. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s) en is dit de enige toegestane waarde.

Waarde	Description
latest

QueryFailure

Object

Foutreactie.

Name	Type	Description
error	Error	Foutdefinitie.

SummarizeResults

Object

Actieresultaten samenvatten.

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 (int32) minimum: 1 maximum: 1	Aantal OData-entiteiten; vertegenwoordigt het aantal geretourneerde samenvattingen; altijd ingesteld op 1.
value	Summary[]	Actieresultaten samenvatten.

Summary

Object

Samenvattingsresultaten.

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 samenvattingen geen entiteits-id hebben.
policyAssignments	PolicyAssignmentSummary[]	Overzicht van beleidstoewijzingen.
results	SummaryResults	Overzicht van naleving voor alle beleidstoewijzingen.

SummaryResults

Object

Nalevingsoverzicht op een bepaald overzichtsniveau.

Name	Type	Description
nonCompliantPolicies	integer (int32) minimum: 0	Aantal niet-compatibele beleidsregels.
nonCompliantResources	integer (int32) minimum: 0	Aantal niet-compatibele resources.
policyDetails	ComplianceDetail[]	De samenvatting van het beleidsartefact op dit niveau. Voor het bereikniveau van de query vertegenwoordigt het overzicht van beleidstoewijzing. Voor beleidstoewijzingsniveau vertegenwoordigt het overzicht van beleidsdefinities.
policyGroupDetails	ComplianceDetail[]	De samenvatting van de beleidsdefinitiegroep op dit niveau.
queryResultsUri	string	HTTP POST-URI voor queryResults-actie op Microsoft.PolicyInsights om onbewerkte resultaten op te halen voor het nalevingsoverzicht. Deze eigenschap is niet standaard beschikbaar in toekomstige API-versies, maar kan expliciet worden opgevraagd.
resourceDetails	ComplianceDetail[]	De samenvatting van de resources op dit niveau.