Share via


MockablePolicyInsightsSubscriptionResource.SummarizeForPolicyDefinitionPolicyStates Method

Definition

Summarizes policy states for the subscription level policy definition.

  • Request Path: /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
  • Operation Id: PolicyStates_SummarizeForPolicyDefinition
public virtual Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizeForPolicyDefinitionPolicyStates (string policyDefinitionName, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SummarizeForPolicyDefinitionPolicyStates : string * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>
override this.SummarizeForPolicyDefinitionPolicyStates : string * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>
Public Overridable Function SummarizeForPolicyDefinitionPolicyStates (policyDefinitionName As String, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)

Parameters

policyDefinitionName
String

Policy definition name.

policyStateSummaryType
PolicyStateSummaryType

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.

policyQuerySettings
PolicyQuerySettings

Parameter group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of PolicySummary that may take multiple service requests to iterate over.

Exceptions

policyDefinitionName is an empty string, and was expected to be non-empty.

policyDefinitionName is null.

Applies to