Policy States - Summarize For Policy Set Definition

Service:

Policy

API Version:

2019-10-01

Résume les états de stratégie pour la définition de l’ensemble de stratégies au niveau de l’abonnement.

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

With optional parameters:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
authorizationNamespace	path	True	AuthorizationNamespaceType	Espace de noms pour le fournisseur de ressources d’autorisation Microsoft ; seul « Microsoft.Authorization » est autorisé.
policySetDefinitionName	path	True	string	Nom de la définition du jeu de stratégies.
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	Ressource virtuelle sous Type de ressource PolicyStates pour l’action de synthèse. Dans un intervalle de temps donné, « latest » représente le ou les états de stratégie les plus récents et est la seule valeur autorisée.
subscriptionId	path	True	string	ID d’abonnement Microsoft Azure.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Expression de filtre OData.
$from	query		string date-time	Horodatage au format ISO 8601 spécifiant l’heure de début de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise ($to - 1 jour).
$to	query		string date-time	Horodatage au format ISO 8601 spécifiant l’heure de fin de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise l’heure de la requête.
$top	query		integer int32	Nombre maximal d’enregistrements à retourner.

Réponses

Nom	Type	Description
200 OK	SummarizeResults	Résumez les résultats.
Other Status Codes	QueryFailure	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Summarize at policy set definition scope

Sample Request

HTTP

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'

Java

import com.azure.core.util.Context;
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'",
                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_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

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

JavaScript

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

Sample Response

Status code:

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

Définitions

Nom	Description
AuthorizationNamespaceType	Espace de noms pour le fournisseur de ressources d’autorisation Microsoft ; seul « Microsoft.Authorization » est autorisé.
ComplianceDetail	Cumul de l’état de conformité.
Error	Définition de l’erreur.
PolicyAssignmentSummary	Résumé de l’affectation de stratégie.
PolicyDefinitionSummary	Résumé de la définition de stratégie.
PolicyGroupSummary	Résumé du groupe de définitions de stratégie.
PolicyStatesSummaryResourceType	Ressource virtuelle sous Type de ressource PolicyStates pour l’action de synthèse. Dans un intervalle de temps donné, « latest » représente le ou les états de stratégie les plus récents et est la seule valeur autorisée.
QueryFailure	Réponse d’erreur.
SummarizeResults	Résumer les résultats de l’action.
Summary	Résultats récapitulatives.
SummaryResults	Résumé de la conformité à un niveau de résumé particulier.

AuthorizationNamespaceType

Espace de noms pour le fournisseur de ressources d’autorisation Microsoft ; seul « Microsoft.Authorization » est autorisé.

Nom	Type	Description
Microsoft.Authorization	string

ComplianceDetail

Cumul de l’état de conformité.

Nom	Type	Description
complianceState	string	État de conformité.
count	integer	Valeur du nombre résumé pour cet état de conformité.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
message	string	Description de l'erreur.

PolicyAssignmentSummary

Résumé de l’affectation de stratégie.

Nom	Type	Description
policyAssignmentId	string	ID d’affectation de stratégie.
policyDefinitions	PolicyDefinitionSummary[]	Résumé des définitions de stratégie.
policyGroups	PolicyGroupSummary[]	Résumé du groupe de définitions de stratégie.
policySetDefinitionId	string	ID de définition de jeu de stratégies, si l’attribution de stratégie concerne un ensemble de stratégies.
results	SummaryResults	Résumé de la conformité pour l’attribution de stratégie.

PolicyDefinitionSummary

Résumé de la définition de stratégie.

Nom	Type	Description
effect	string	Effet de stratégie, c’est-à-dire action de définition de stratégie.
policyDefinitionGroupNames	string[]	Noms de groupes de définition de stratégie.
policyDefinitionId	string	ID de définition de stratégie.
policyDefinitionReferenceId	string	ID de référence de définition de stratégie.
results	SummaryResults	Résumé de la conformité pour la définition de stratégie.

PolicyGroupSummary

Résumé du groupe de définitions de stratégie.

Nom	Type	Description
policyGroupName	string	Nom du groupe de stratégies.
results	SummaryResults	Résumé de la conformité pour le groupe de définitions de stratégie.

PolicyStatesSummaryResourceType

Ressource virtuelle sous Type de ressource PolicyStates pour l’action de synthèse. Dans un intervalle de temps donné, « latest » représente le ou les états de stratégie les plus récents et est la seule valeur autorisée.

Nom	Type	Description
latest	string

QueryFailure

Réponse d’erreur.

Nom	Type	Description
error	Error	Définition de l’erreur.

SummarizeResults

Résumer les résultats de l’action.

Nom	Type	Description
@odata.context	string	Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.
@odata.count	integer	Nombre d’entités OData ; représente le nombre de résumés retournés ; toujours défini sur 1.
value	Summary[]	Résumer les résultats de l’action.

Summary

Résultats récapitulatives.

Nom	Type	Description
@odata.context	string	Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.
@odata.id	string	ID d’entité OData ; toujours défini sur null, car les résumés n’ont pas d’ID d’entité.
policyAssignments	PolicyAssignmentSummary[]	Résumé des affectations de stratégie.
results	SummaryResults	Résumé de la conformité pour toutes les attributions de stratégie.

SummaryResults

Résumé de la conformité à un niveau de résumé particulier.

Nom	Type	Description
nonCompliantPolicies	integer	Nombre de stratégies non conformes.
nonCompliantResources	integer	Nombre de ressources non conformes.
policyDetails	ComplianceDetail[]	Résumé de l’artefact de stratégie à ce niveau. Pour le niveau d’étendue de la requête, il représente le résumé de l’affectation de stratégie. Pour le niveau d’affectation de stratégie, il représente le résumé des définitions de stratégie.
policyGroupDetails	ComplianceDetail[]	Résumé du groupe de définition de stratégie à ce niveau.
queryResultsUri	string	URI HTTP POST pour l’action queryResults sur Microsoft.PolicyInsights pour récupérer les résultats bruts du résumé de conformité. Cette propriété ne sera pas disponible par défaut dans les versions futures de l’API, mais peut être interrogée explicitement.
resourceDetails	ComplianceDetail[]	Résumé des ressources à ce niveau.