Sign in

v7

latestSwagger 2.0raw.githubusercontent.com2022-02-22181455.7 KB

Summarizes policy states for the subscription level policy definition.

post/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize

Path parameters

policyStatesSummaryResource'latest' required

The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value.

subscriptionIdstring required

Microsoft Azure subscription ID.

authorizationNamespace'Microsoft.Authorization' required

The namespace for Microsoft Authorization resource provider; only "Microsoft.Authorization" is allowed.

policyDefinitionNamestring required

Policy definition name.

Query parameters

api-versionstring required

Client Api Version.

$topinteger

Maximum number of records to return.

$fromstring date-time

ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).

$tostring date-time

ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.

$filterstring

OData filter expression.

Response

Summarize results.

@odata.contextstring

OData context string; used by OData clients to resolve type information based on metadata.

@odata.countinteger

OData entity count; represents the number of summaries returned; always set to 1.