PolicyStatesOperations interface

Package:
@azure/arm-policyinsights

Interface representing a PolicyStates operations.

Properties

beginTriggerResourceGroupEvaluation
beginTriggerResourceGroupEvaluationAndWait
beginTriggerSubscriptionEvaluation
beginTriggerSubscriptionEvaluationAndWait
listQueryResultsForManagementGroup

Queries policy states for the resources under the management group.
listQueryResultsForPolicyDefinition

Queries policy states for the subscription level policy definition.
listQueryResultsForPolicySetDefinition

Queries policy states for the subscription level policy set definition.
listQueryResultsForResource

Queries policy states for the resource.
listQueryResultsForResourceGroup

Queries policy states for the resources under the resource group.
listQueryResultsForResourceGroupLevelPolicyAssignment

Queries policy states for the resource group level policy assignment.
listQueryResultsForSubscription

Queries policy states for the resources under the subscription.
listQueryResultsForSubscriptionLevelPolicyAssignment

Queries policy states for the subscription level policy assignment.
summarizeForManagementGroup

Summarizes policy states for the resources under the management group.
summarizeForPolicyDefinition

Summarizes policy states for the subscription level policy definition.
summarizeForPolicySetDefinition

Summarizes policy states for the subscription level policy set definition.
summarizeForResource

Summarizes policy states for the resource.
summarizeForResourceGroup

Summarizes policy states for the resources under the resource group.
summarizeForResourceGroupLevelPolicyAssignment

Summarizes policy states for the resource group level policy assignment.
summarizeForSubscription

Summarizes policy states for the resources under the subscription.
summarizeForSubscriptionLevelPolicyAssignment

Summarizes policy states for the subscription level policy assignment.
triggerResourceGroupEvaluation

Triggers a policy evaluation scan for all the resources under the resource group.
triggerSubscriptionEvaluation

Triggers a policy evaluation scan for all the resources under the subscription

Property Details

beginTriggerResourceGroupEvaluation

Warning

This API is now deprecated.

use triggerResourceGroupEvaluation instead

beginTriggerResourceGroupEvaluation: (subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginTriggerResourceGroupEvaluationAndWait

Warning

This API is now deprecated.

use triggerResourceGroupEvaluation instead

beginTriggerResourceGroupEvaluationAndWait: (subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => Promise<void>

Property Value

(subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => Promise<void>

beginTriggerSubscriptionEvaluation

Warning

This API is now deprecated.

use triggerSubscriptionEvaluation instead

beginTriggerSubscriptionEvaluation: (subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginTriggerSubscriptionEvaluationAndWait

Warning

This API is now deprecated.

use triggerSubscriptionEvaluation instead

beginTriggerSubscriptionEvaluationAndWait: (subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => Promise<void>

Property Value

(subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => Promise<void>

listQueryResultsForManagementGroup

Queries policy states for the resources under the management group.

listQueryResultsForManagementGroup: (policyStatesResource: string, managementGroupName: string, options?: PolicyStatesListQueryResultsForManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, managementGroupName: string, options?: PolicyStatesListQueryResultsForManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForPolicyDefinition

Queries policy states for the subscription level policy definition.

listQueryResultsForPolicyDefinition: (policyStatesResource: string, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForPolicySetDefinition

Queries policy states for the subscription level policy set definition.

listQueryResultsForPolicySetDefinition: (policyStatesResource: string, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResource

Queries policy states for the resource.

listQueryResultsForResource: (policyStatesResource: string, resourceId: string, options?: PolicyStatesListQueryResultsForResourceOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, resourceId: string, options?: PolicyStatesListQueryResultsForResourceOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResourceGroup

Queries policy states for the resources under the resource group.

listQueryResultsForResourceGroup: (policyStatesResource: string, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesListQueryResultsForResourceGroupOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesListQueryResultsForResourceGroupOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResourceGroupLevelPolicyAssignment

Queries policy states for the resource group level policy assignment.

listQueryResultsForResourceGroupLevelPolicyAssignment: (policyStatesResource: string, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForSubscription

Queries policy states for the resources under the subscription.

listQueryResultsForSubscription: (policyStatesResource: string, subscriptionId: string, options?: PolicyStatesListQueryResultsForSubscriptionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, options?: PolicyStatesListQueryResultsForSubscriptionOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForSubscriptionLevelPolicyAssignment

Queries policy states for the subscription level policy assignment.

listQueryResultsForSubscriptionLevelPolicyAssignment: (policyStatesResource: string, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

Property Value

(policyStatesResource: string, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams) => PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

summarizeForManagementGroup

Summarizes policy states for the resources under the management group.

summarizeForManagementGroup: (policyStatesSummaryResource: string, managementGroupName: string, options?: PolicyStatesSummarizeForManagementGroupOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, managementGroupName: string, options?: PolicyStatesSummarizeForManagementGroupOptionalParams) => Promise<SummarizeResults>

summarizeForPolicyDefinition

Summarizes policy states for the subscription level policy definition.

summarizeForPolicyDefinition: (policyStatesSummaryResource: string, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesSummarizeForPolicyDefinitionOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesSummarizeForPolicyDefinitionOptionalParams) => Promise<SummarizeResults>

summarizeForPolicySetDefinition

Summarizes policy states for the subscription level policy set definition.

summarizeForPolicySetDefinition: (policyStatesSummaryResource: string, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesSummarizeForPolicySetDefinitionOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesSummarizeForPolicySetDefinitionOptionalParams) => Promise<SummarizeResults>

summarizeForResource

Summarizes policy states for the resource.

summarizeForResource: (policyStatesSummaryResource: string, resourceId: string, options?: PolicyStatesSummarizeForResourceOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, resourceId: string, options?: PolicyStatesSummarizeForResourceOptionalParams) => Promise<SummarizeResults>

summarizeForResourceGroup

Summarizes policy states for the resources under the resource group.

summarizeForResourceGroup: (policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesSummarizeForResourceGroupOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesSummarizeForResourceGroupOptionalParams) => Promise<SummarizeResults>

summarizeForResourceGroupLevelPolicyAssignment

Summarizes policy states for the resource group level policy assignment.

summarizeForResourceGroupLevelPolicyAssignment: (policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams) => Promise<SummarizeResults>

summarizeForSubscription

Summarizes policy states for the resources under the subscription.

summarizeForSubscription: (policyStatesSummaryResource: string, subscriptionId: string, options?: PolicyStatesSummarizeForSubscriptionOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, options?: PolicyStatesSummarizeForSubscriptionOptionalParams) => Promise<SummarizeResults>

summarizeForSubscriptionLevelPolicyAssignment

Summarizes policy states for the subscription level policy assignment.

summarizeForSubscriptionLevelPolicyAssignment: (policyStatesSummaryResource: string, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams) => Promise<SummarizeResults>

Property Value

(policyStatesSummaryResource: string, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams) => Promise<SummarizeResults>

triggerResourceGroupEvaluation

Triggers a policy evaluation scan for all the resources under the resource group.

triggerResourceGroupEvaluation: (subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams) => PollerLike<OperationState<void>, void>

triggerSubscriptionEvaluation

Triggers a policy evaluation scan for all the resources under the subscription

triggerSubscriptionEvaluation: (subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams) => PollerLike<OperationState<void>, void>