Policy States - Summarize For Policy Set Definition

Referência

Serviço:: Policy

Versão da API:: 2019-10-01

Resume os estados de política para a definição do conjunto de políticas de nível de assinatura.

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

Com parâmetros opcionais:

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}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
authorizationNamespace	path	True	AuthorizationNamespaceType	O namespace para o provedor de recursos de autorização da Microsoft; somente "Microsoft.Authorization" é permitido.
policySetDefinitionName	path	True	string	Nome da definição do conjunto de políticas.
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	O recurso virtual no tipo de recurso PolicyStates para resumir a ação. Em um determinado intervalo de tempo, 'latest' representa os últimos estados de política e é o único valor permitido.
subscriptionId	path	True	string	ID da assinatura do Microsoft Azure.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Expressão de filtro OData.
$from	query		string (date-time)	Carimbo de data/hora formatado ISO 8601 especificando a hora de início do intervalo a ser consultado. Quando não especificado, o serviço usa ($to – 1 dia).
$to	query		string (date-time)	Carimbo de data/hora formatado iso 8601 especificando a hora de término do intervalo a ser consultado. Quando não especificado, o serviço usa o tempo de solicitação.
$top	query		integer (int32) minimum: 0	Número máximo de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	SummarizeResults	Resumir resultados.
Other Status Codes	QueryFailure	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Summarize at policy set definition scope

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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": []
    }
  ]
}

Definições

Nome	Description
AuthorizationNamespaceType	O namespace para o provedor de recursos de autorização da Microsoft; somente "Microsoft.Authorization" é permitido.
ComplianceDetail	O rollup de estado de conformidade.
Error	Definição de erro.
PolicyAssignmentSummary	Resumo da atribuição de política.
PolicyDefinitionSummary	Resumo da definição de política.
PolicyGroupSummary	Resumo do grupo de definição de política.
PolicyStatesSummaryResourceType	O recurso virtual no tipo de recurso PolicyStates para resumir a ação. Em um determinado intervalo de tempo, 'latest' representa os últimos estados de política e é o único valor permitido.
QueryFailure	Resposta de erro.
SummarizeResults	Resumir os resultados da ação.
Summary	Resultados de resumo.
SummaryResults	Resumo de conformidade em um nível de resumo específico.

AuthorizationNamespaceType

Enumeração

O namespace para o provedor de recursos de autorização da Microsoft; somente "Microsoft.Authorization" é permitido.

Valor	Description
Microsoft.Authorization

ComplianceDetail

Objeto

O rollup de estado de conformidade.

Nome	Tipo	Description
complianceState	string	O estado de conformidade.
count	integer (int32)	Valor de contagem resumido para esse estado de conformidade.

Error

Objeto

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
message	string	Descrição do erro.

PolicyAssignmentSummary

Objeto

Resumo da atribuição de política.

Nome	Tipo	Description
policyAssignmentId	string	ID da atribuição de política.
policyDefinitions	PolicyDefinitionSummary[]	Resumo das definições de política.
policyGroups	PolicyGroupSummary[]	Resumo do grupo de definição de política.
policySetDefinitionId	string	ID de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas.
results	SummaryResults	Resumo de conformidade para a atribuição de política.

PolicyDefinitionSummary

Objeto

Resumo da definição de política.

Nome	Tipo	Description
effect	string	Efeito de política, ou seja, ação de definição de política.
policyDefinitionGroupNames	string[]	Nomes de grupo de definição de política.
policyDefinitionId	string	ID de definição de política.
policyDefinitionReferenceId	string	ID de referência de definição de política.
results	SummaryResults	Resumo de conformidade para a definição de política.

PolicyGroupSummary

Objeto

Resumo do grupo de definição de política.

Nome	Tipo	Description
policyGroupName	string	Nome do grupo de políticas.
results	SummaryResults	Resumo de conformidade para o grupo de definição de política.

PolicyStatesSummaryResourceType

Enumeração

O recurso virtual no tipo de recurso PolicyStates para resumir a ação. Em um determinado intervalo de tempo, 'latest' representa os últimos estados de política e é o único valor permitido.

Valor	Description
latest

QueryFailure

Objeto

Resposta de erro.

Nome	Tipo	Description
error	Error	Definição de erro.

SummarizeResults

Objeto

Resumir os resultados da ação.

Nome	Tipo	Description
@odata.context	string	Cadeia de caracteres de contexto OData; usado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.count	integer (int32) minimum: 1 maximum: 1	Contagem de entidades OData; representa o número de resumos retornados; sempre definido como 1.
value	Summary[]	Resumir os resultados da ação.

Summary

Objeto

Resultados de resumo.

Nome	Tipo	Description
@odata.context	string	Cadeia de caracteres de contexto OData; usado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.id	string	ID da entidade OData; sempre definido como nulo, pois os resumos não têm uma ID de entidade.
policyAssignments	PolicyAssignmentSummary[]	Resumo das atribuições de política.
results	SummaryResults	Resumo de conformidade para todas as atribuições de política.

SummaryResults

Objeto

Resumo de conformidade em um nível de resumo específico.

Nome	Tipo	Description
nonCompliantPolicies	integer (int32) minimum: 0	Número de políticas não compatíveis.
nonCompliantResources	integer (int32) minimum: 0	Número de recursos não compatíveis.
policyDetails	ComplianceDetail[]	O resumo do artefato de política neste nível. Para o nível de escopo da consulta, ele representa o resumo da atribuição de política. Para o nível de atribuição de política, ele representa o resumo das definições de política.
policyGroupDetails	ComplianceDetail[]	O resumo do grupo de definição de política nesse nível.
queryResultsUri	string	URI HTTP POST para a ação queryResults no Microsoft.PolicyInsights para recuperar resultados brutos para o resumo de conformidade. Essa propriedade não estará disponível por padrão em versões futuras da API, mas pode ser consultada explicitamente.
resourceDetails	ComplianceDetail[]	O resumo de recursos nesse nível.

Compartilhar via

Policy States - Summarize For Policy Set Definition

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Summarize at policy set definition scope

Solicitação de exemplo

Resposta de exemplo

Definições

AuthorizationNamespaceType

ComplianceDetail

Error

PolicyAssignmentSummary

PolicyDefinitionSummary

PolicyGroupSummary

PolicyStatesSummaryResourceType

QueryFailure

SummarizeResults

Summary

SummaryResults