Share via

PolicyStates interface

  • Reference
Package:
@azure/arm-policyinsights

Interface representing a PolicyStates.

Methods

beginTriggerResourceGroupEvaluation(string, string, PolicyStatesTriggerResourceGroupEvaluationOptionalParams)

Triggers a policy evaluation scan for all the resources under the resource group.
beginTriggerResourceGroupEvaluationAndWait(string, string, PolicyStatesTriggerResourceGroupEvaluationOptionalParams)

Triggers a policy evaluation scan for all the resources under the resource group.
beginTriggerSubscriptionEvaluation(string, PolicyStatesTriggerSubscriptionEvaluationOptionalParams)

Triggers a policy evaluation scan for all the resources under the subscription
beginTriggerSubscriptionEvaluationAndWait(string, PolicyStatesTriggerSubscriptionEvaluationOptionalParams)

Triggers a policy evaluation scan for all the resources under the subscription
listQueryResultsForManagementGroup(string, string, PolicyStatesListQueryResultsForManagementGroupOptionalParams)

Queries policy states for the resources under the management group.
listQueryResultsForPolicyDefinition(string, string, string, PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams)

Queries policy states for the subscription level policy definition.
listQueryResultsForPolicySetDefinition(string, string, string, PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams)

Queries policy states for the subscription level policy set definition.
listQueryResultsForResource(string, string, PolicyStatesListQueryResultsForResourceOptionalParams)

Queries policy states for the resource.
listQueryResultsForResourceGroup(string, string, string, PolicyStatesListQueryResultsForResourceGroupOptionalParams)

Queries policy states for the resources under the resource group.
listQueryResultsForResourceGroupLevelPolicyAssignment(string, string, string, string, PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams)

Queries policy states for the resource group level policy assignment.
listQueryResultsForSubscription(string, string, PolicyStatesListQueryResultsForSubscriptionOptionalParams)

Queries policy states for the resources under the subscription.
listQueryResultsForSubscriptionLevelPolicyAssignment(string, string, string, PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams)

Queries policy states for the subscription level policy assignment.
summarizeForManagementGroup(string, PolicyStatesSummarizeForManagementGroupOptionalParams)

Summarizes policy states for the resources under the management group.
summarizeForPolicyDefinition(string, string, PolicyStatesSummarizeForPolicyDefinitionOptionalParams)

Summarizes policy states for the subscription level policy definition.
summarizeForPolicySetDefinition(string, string, PolicyStatesSummarizeForPolicySetDefinitionOptionalParams)

Summarizes policy states for the subscription level policy set definition.
summarizeForResource(string, PolicyStatesSummarizeForResourceOptionalParams)

Summarizes policy states for the resource.
summarizeForResourceGroup(string, string, PolicyStatesSummarizeForResourceGroupOptionalParams)

Summarizes policy states for the resources under the resource group.
summarizeForResourceGroupLevelPolicyAssignment(string, string, string, PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams)

Summarizes policy states for the resource group level policy assignment.
summarizeForSubscription(string, PolicyStatesSummarizeForSubscriptionOptionalParams)

Summarizes policy states for the resources under the subscription.
summarizeForSubscriptionLevelPolicyAssignment(string, string, PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams)

Summarizes policy states for the subscription level policy assignment.

Method Details

beginTriggerResourceGroupEvaluation(string, string, PolicyStatesTriggerResourceGroupEvaluationOptionalParams)

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

function beginTriggerResourceGroupEvaluation(subscriptionId: string, resourceGroupName: string, options?: PolicyStatesTriggerResourceGroupEvaluationOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

options
PolicyStatesTriggerResourceGroupEvaluationOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginTriggerResourceGroupEvaluationAndWait(string, string, PolicyStatesTriggerResourceGroupEvaluationOptionalParams)

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

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

options
PolicyStatesTriggerResourceGroupEvaluationOptionalParams

The options parameters.

Returns

Promise<void>

beginTriggerSubscriptionEvaluation(string, PolicyStatesTriggerSubscriptionEvaluationOptionalParams)

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

function beginTriggerSubscriptionEvaluation(subscriptionId: string, options?: PolicyStatesTriggerSubscriptionEvaluationOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

options
PolicyStatesTriggerSubscriptionEvaluationOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginTriggerSubscriptionEvaluationAndWait(string, PolicyStatesTriggerSubscriptionEvaluationOptionalParams)

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

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

options
PolicyStatesTriggerSubscriptionEvaluationOptionalParams

The options parameters.

Returns

Promise<void>

listQueryResultsForManagementGroup(string, string, PolicyStatesListQueryResultsForManagementGroupOptionalParams)

Queries policy states for the resources under the management group.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

managementGroupName

string

Management group name.

options
PolicyStatesListQueryResultsForManagementGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForPolicyDefinition(string, string, string, PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams)

Queries policy states for the subscription level policy definition.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

policyDefinitionName

string

Policy definition name.

options
PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForPolicySetDefinition(string, string, string, PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams)

Queries policy states for the subscription level policy set definition.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

policySetDefinitionName

string

Policy set definition name.

options
PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResource(string, string, PolicyStatesListQueryResultsForResourceOptionalParams)

Queries policy states for the resource.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

resourceId

string

Resource ID.

options
PolicyStatesListQueryResultsForResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResourceGroup(string, string, string, PolicyStatesListQueryResultsForResourceGroupOptionalParams)

Queries policy states for the resources under the resource group.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

options
PolicyStatesListQueryResultsForResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForResourceGroupLevelPolicyAssignment(string, string, string, string, PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams)

Queries policy states for the resource group level policy assignment.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

policyAssignmentName

string

Policy assignment name.

options
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForSubscription(string, string, PolicyStatesListQueryResultsForSubscriptionOptionalParams)

Queries policy states for the resources under the subscription.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

options
PolicyStatesListQueryResultsForSubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

listQueryResultsForSubscriptionLevelPolicyAssignment(string, string, string, PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams)

Queries policy states for the subscription level policy assignment.

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

Parameters

policyStatesResource

string

The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).

subscriptionId

string

Microsoft Azure subscription ID.

policyAssignmentName

string

Policy assignment name.

options
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PolicyState, PolicyState[], PageSettings>

summarizeForManagementGroup(string, PolicyStatesSummarizeForManagementGroupOptionalParams)

Summarizes policy states for the resources under the management group.

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

Parameters

managementGroupName

string

Management group name.

options
PolicyStatesSummarizeForManagementGroupOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForPolicyDefinition(string, string, PolicyStatesSummarizeForPolicyDefinitionOptionalParams)

Summarizes policy states for the subscription level policy definition.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

policyDefinitionName

string

Policy definition name.

options
PolicyStatesSummarizeForPolicyDefinitionOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForPolicySetDefinition(string, string, PolicyStatesSummarizeForPolicySetDefinitionOptionalParams)

Summarizes policy states for the subscription level policy set definition.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

policySetDefinitionName

string

Policy set definition name.

options
PolicyStatesSummarizeForPolicySetDefinitionOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForResource(string, PolicyStatesSummarizeForResourceOptionalParams)

Summarizes policy states for the resource.

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

Parameters

resourceId

string

Resource ID.

options
PolicyStatesSummarizeForResourceOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForResourceGroup(string, string, PolicyStatesSummarizeForResourceGroupOptionalParams)

Summarizes policy states for the resources under the resource group.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

options
PolicyStatesSummarizeForResourceGroupOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForResourceGroupLevelPolicyAssignment(string, string, string, PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams)

Summarizes policy states for the resource group level policy assignment.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

resourceGroupName

string

Resource group name.

policyAssignmentName

string

Policy assignment name.

options
PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForSubscription(string, PolicyStatesSummarizeForSubscriptionOptionalParams)

Summarizes policy states for the resources under the subscription.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

options
PolicyStatesSummarizeForSubscriptionOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>

summarizeForSubscriptionLevelPolicyAssignment(string, string, PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams)

Summarizes policy states for the subscription level policy assignment.

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

Parameters

subscriptionId

string

Microsoft Azure subscription ID.

policyAssignmentName

string

Policy assignment name.

options
PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams

The options parameters.

Returns

Promise<SummarizeResults>