MockablePolicyInsightsArmClient.SummarizePolicyStatesAsync Method

Definition

Summarizes policy states for the resource.

  • Request Path: /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
  • Operation Id: PolicyStates_SummarizeForResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStatesAsync (Azure.Core.ResourceIdentifier scope, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SummarizePolicyStatesAsync : Azure.Core.ResourceIdentifier * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>
override this.SummarizePolicyStatesAsync : Azure.Core.ResourceIdentifier * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>
Public Overridable Function SummarizePolicyStatesAsync (scope As ResourceIdentifier, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PolicySummary)

Parameters

scope
ResourceIdentifier

The scope that the resource will apply against.

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

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

Exceptions

scope is null.

Applies to