MockablePolicyInsightsSubscriptionResource.SummarizeForPolicySetDefinitionPolicyStatesAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.PolicyInsights.Mocking

Assembly:: Azure.ResourceManager.PolicyInsights.dll

Package:: Azure.ResourceManager.PolicyInsights v1.2.0

Source:: MockablePolicyInsightsSubscriptionResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Summarizes policy states for the subscription level policy set definition.

Request Path: /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
Operation Id: PolicyStates_SummarizeForPolicySetDefinition

public virtual Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizeForPolicySetDefinitionPolicyStatesAsync (string policySetDefinitionName, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SummarizeForPolicySetDefinitionPolicyStatesAsync : string * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>
override this.SummarizeForPolicySetDefinitionPolicyStatesAsync : string * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary>

Public Overridable Function SummarizeForPolicySetDefinitionPolicyStatesAsync (policySetDefinitionName As String, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PolicySummary)

Parameters

policySetDefinitionName: String

Policy set 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

AsyncPageable<PolicySummary>

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

Exceptions

ArgumentException

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

ArgumentNullException

policySetDefinitionName is null.

Applies to

Share via