PolicyInsightsExtensions.SummarizePolicyStates Method
Definition
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.
Overloads
| SummarizePolicyStates(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resources under the management group.
|
| SummarizePolicyStates(PolicyAssignmentResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the subscription level or resource group level policy assignment.
|
| SummarizePolicyStates(ResourceGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resources under the resource group.
|
| SummarizePolicyStates(SubscriptionPolicyDefinitionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the subscription level policy definition.
|
| SummarizePolicyStates(SubscriptionPolicySetDefinitionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the subscription level policy set definition.
|
| SummarizePolicyStates(SubscriptionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resources under the subscription.
|
| SummarizePolicyStates(ArmClient, ResourceIdentifier, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resource.
|
SummarizePolicyStates(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the resources under the management group.
- Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForManagementGroup
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.ManagementGroups.ManagementGroupResource managementGroupResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.ManagementGroups.ManagementGroupResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (managementGroupResource As ManagementGroupResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- managementGroupResource
- ManagementGroupResource
The ManagementGroupResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Exceptions
managementGroupResource is null.
Applies to
SummarizePolicyStates(PolicyAssignmentResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the subscription level or resource group level policy assignment.
- Request Path: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForResourceGroupLevelPolicyAssignment
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.Resources.PolicyAssignmentResource policyAssignmentResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.Resources.PolicyAssignmentResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (policyAssignmentResource As PolicyAssignmentResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- policyAssignmentResource
- PolicyAssignmentResource
The PolicyAssignmentResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Applies to
SummarizePolicyStates(ResourceGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the resources under the resource group.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForResourceGroup
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (resourceGroupResource As ResourceGroupResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Exceptions
resourceGroupResource is null.
Applies to
SummarizePolicyStates(SubscriptionPolicyDefinitionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the subscription level policy definition.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForPolicyDefinition
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.Resources.SubscriptionPolicyDefinitionResource subscriptionPolicyDefinitionResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.Resources.SubscriptionPolicyDefinitionResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (subscriptionPolicyDefinitionResource As SubscriptionPolicyDefinitionResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- subscriptionPolicyDefinitionResource
- SubscriptionPolicyDefinitionResource
The SubscriptionPolicyDefinitionResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Applies to
SummarizePolicyStates(SubscriptionPolicySetDefinitionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the subscription level policy set definition.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForPolicySetDefinition
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.Resources.SubscriptionPolicySetDefinitionResource subscriptionPolicySetDefinitionResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.Resources.SubscriptionPolicySetDefinitionResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (subscriptionPolicySetDefinitionResource As SubscriptionPolicySetDefinitionResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- subscriptionPolicySetDefinitionResource
- SubscriptionPolicySetDefinitionResource
The SubscriptionPolicySetDefinitionResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Applies to
SummarizePolicyStates(SubscriptionResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the resources under the subscription.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForSubscription
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (subscriptionResource As SubscriptionResource, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicySummary)Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute 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
A collection of PolicySummary that may take multiple service requests to iterate over.
Exceptions
subscriptionResource is null.
Applies to
SummarizePolicyStates(ArmClient, ResourceIdentifier, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)
- Source:
- PolicyInsightsExtensions.cs
- Source:
- PolicyInsightsExtensions.cs
Summarizes policy states for the resource.
- Request Path: /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
- Operation Id: PolicyStates_SummarizeForResource
public static Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary> SummarizePolicyStates (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType policyStateSummaryType, Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings policyQuerySettings = default, System.Threading.CancellationToken cancellationToken = default);static member SummarizePolicyStates : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * Azure.ResourceManager.PolicyInsights.Models.PolicyStateSummaryType * Azure.ResourceManager.PolicyInsights.Models.PolicyQuerySettings * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PolicyInsights.Models.PolicySummary><Extension()>
Public Function SummarizePolicyStates (client As ArmClient, scope As ResourceIdentifier, policyStateSummaryType As PolicyStateSummaryType, Optional policyQuerySettings As PolicyQuerySettings = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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
Exceptions
client is null.
