PolicyStatesImpl | @azure/arm-policyinsights

Class containing PolicyStates operations.

Hierarchy

PolicyStatesImpl

Implements

PolicyStates

Index

Constructors

constructor

Methods

Constructors

constructor

new PolicyStatesImpl(client: PolicyInsightsClient): PolicyStatesImpl

- Defined in operations/policyStates.ts:76
Initialize a new instance of the class PolicyStates class.

Parameters
- client: PolicyInsightsClient
  
  Reference to the service client
Returns PolicyStatesImpl

Methods

beginTriggerResourceGroupEvaluation

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

Implementation of PolicyStates.beginTriggerResourceGroupEvaluation
- Defined in operations/policyStates.ts:969
Triggers a policy evaluation scan for all the resources under the resource group.

Parameters
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- resourceGroupName: string
  
  Resource group name.
- Optional options: PolicyStatesTriggerResourceGroupEvaluationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginTriggerResourceGroupEvaluationAndWait

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

Implementation of PolicyStates.beginTriggerResourceGroupEvaluationAndWait
- Defined in operations/policyStates.ts:1033
Triggers a policy evaluation scan for all the resources under the resource group.

Parameters
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- resourceGroupName: string
  
  Resource group name.
- Optional options: PolicyStatesTriggerResourceGroupEvaluationOptionalParams
  
  The options parameters.
Returns Promise<void>

beginTriggerSubscriptionEvaluation

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

Implementation of PolicyStates.beginTriggerSubscriptionEvaluation
- Defined in operations/policyStates.ts:890
Triggers a policy evaluation scan for all the resources under the subscription

Parameters
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- Optional options: PolicyStatesTriggerSubscriptionEvaluationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginTriggerSubscriptionEvaluationAndWait

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

Implementation of PolicyStates.beginTriggerSubscriptionEvaluationAndWait
- Defined in operations/policyStates.ts:952
Triggers a policy evaluation scan for all the resources under the subscription

Parameters
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- Optional options: PolicyStatesTriggerSubscriptionEvaluationOptionalParams
  
  The options parameters.
Returns Promise<void>

listQueryResultsForManagementGroup

listQueryResultsForManagementGroup(policyStatesResource: PolicyStatesResource, managementGroupName: string, options?: PolicyStatesListQueryResultsForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForManagementGroup
- Defined in operations/policyStates.ts:94
Queries policy states for the resources under the management group.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForManagementGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForPolicyDefinition

listQueryResultsForPolicyDefinition(policyStatesResource: PolicyStatesResource, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForPolicyDefinition
- Defined in operations/policyStates.ts:478
Queries policy states for the subscription level policy definition.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForPolicySetDefinition

listQueryResultsForPolicySetDefinition(policyStatesResource: PolicyStatesResource, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForPolicySetDefinition
- Defined in operations/policyStates.ts:396
Queries policy states for the subscription level policy set definition.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResource

listQueryResultsForResource(policyStatesResource: PolicyStatesResource, resourceId: string, options?: PolicyStatesListQueryResultsForResourceOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForResource
- Defined in operations/policyStates.ts:322
Queries policy states for the resource.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForResourceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResourceGroup

listQueryResultsForResourceGroup(policyStatesResource: PolicyStatesResource, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesListQueryResultsForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForResourceGroup
- Defined in operations/policyStates.ts:241
Queries policy states for the resources under the resource group.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResourceGroupLevelPolicyAssignment

listQueryResultsForResourceGroupLevelPolicyAssignment(policyStatesResource: PolicyStatesResource, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForResourceGroupLevelPolicyAssignment
- Defined in operations/policyStates.ts:643
Queries policy states for the resource group level policy assignment.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForSubscription

listQueryResultsForSubscription(policyStatesResource: PolicyStatesResource, subscriptionId: string, options?: PolicyStatesListQueryResultsForSubscriptionOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForSubscription
- Defined in operations/policyStates.ts:167
Queries policy states for the resources under the subscription.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForSubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForSubscriptionLevelPolicyAssignment

listQueryResultsForSubscriptionLevelPolicyAssignment(policyStatesResource: PolicyStatesResource, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams): PagedAsyncIterableIterator<PolicyState>

Implementation of PolicyStates.listQueryResultsForSubscriptionLevelPolicyAssignment
- Defined in operations/policyStates.ts:560
Queries policy states for the subscription level policy assignment.

Parameters
- policyStatesResource: PolicyStatesResource
  
  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.
- Optional options: PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PolicyState>

summarizeForManagementGroup

summarizeForManagementGroup(policyStatesSummaryResource: PolicyStatesSummaryResourceType, managementGroupName: string, options?: PolicyStatesSummarizeForManagementGroupOptionalParams): Promise<PolicyStatesSummarizeForManagementGroupResponse>

Implementation of PolicyStates.summarizeForManagementGroup
- Defined in operations/policyStates.ts:751
Summarizes policy states for the resources under the management group.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- managementGroupName: string
  
  Management group name.
- Optional options: PolicyStatesSummarizeForManagementGroupOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForManagementGroupResponse>

summarizeForPolicyDefinition

summarizeForPolicyDefinition(policyStatesSummaryResource: PolicyStatesSummaryResourceType, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesSummarizeForPolicyDefinitionOptionalParams): Promise<PolicyStatesSummarizeForPolicyDefinitionResponse>

Implementation of PolicyStates.summarizeForPolicyDefinition
- Defined in operations/policyStates.ts:1128
Summarizes policy states for the subscription level policy definition.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- policyDefinitionName: string
  
  Policy definition name.
- Optional options: PolicyStatesSummarizeForPolicyDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForPolicyDefinitionResponse>

summarizeForPolicySetDefinition

summarizeForPolicySetDefinition(policyStatesSummaryResource: PolicyStatesSummaryResourceType, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesSummarizeForPolicySetDefinitionOptionalParams): Promise<PolicyStatesSummarizeForPolicySetDefinitionResponse>

Implementation of PolicyStates.summarizeForPolicySetDefinition
- Defined in operations/policyStates.ts:1081
Summarizes policy states for the subscription level policy set definition.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- policySetDefinitionName: string
  
  Policy set definition name.
- Optional options: PolicyStatesSummarizeForPolicySetDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForPolicySetDefinitionResponse>

summarizeForResource

summarizeForResource(policyStatesSummaryResource: PolicyStatesSummaryResourceType, resourceId: string, options?: PolicyStatesSummarizeForResourceOptionalParams): Promise<PolicyStatesSummarizeForResourceResponse>

Implementation of PolicyStates.summarizeForResource
- Defined in operations/policyStates.ts:874
Summarizes policy states for the resource.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- resourceId: string
  
  Resource ID.
- Optional options: PolicyStatesSummarizeForResourceOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForResourceResponse>

summarizeForResourceGroup

summarizeForResourceGroup(policyStatesSummaryResource: PolicyStatesSummaryResourceType, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesSummarizeForResourceGroupOptionalParams): Promise<PolicyStatesSummarizeForResourceGroupResponse>

Implementation of PolicyStates.summarizeForResourceGroup
- Defined in operations/policyStates.ts:830
Summarizes policy states for the resources under the resource group.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- resourceGroupName: string
  
  Resource group name.
- Optional options: PolicyStatesSummarizeForResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForResourceGroupResponse>

summarizeForResourceGroupLevelPolicyAssignment

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

Implementation of PolicyStates.summarizeForResourceGroupLevelPolicyAssignment
- Defined in operations/policyStates.ts:1237
Summarizes policy states for the resource group level policy assignment.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- resourceGroupName: string
  
  Resource group name.
- policyAssignmentName: string
  
  Policy assignment name.
- Optional options: PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentResponse>

summarizeForSubscription

summarizeForSubscription(policyStatesSummaryResource: PolicyStatesSummaryResourceType, subscriptionId: string, options?: PolicyStatesSummarizeForSubscriptionOptionalParams): Promise<PolicyStatesSummarizeForSubscriptionResponse>

Implementation of PolicyStates.summarizeForSubscription
- Defined in operations/policyStates.ts:789
Summarizes policy states for the resources under the subscription.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- Optional options: PolicyStatesSummarizeForSubscriptionOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForSubscriptionResponse>

summarizeForSubscriptionLevelPolicyAssignment

summarizeForSubscriptionLevelPolicyAssignment(policyStatesSummaryResource: PolicyStatesSummaryResourceType, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams): Promise<PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentResponse>

Implementation of PolicyStates.summarizeForSubscriptionLevelPolicyAssignment
- Defined in operations/policyStates.ts:1177
Summarizes policy states for the subscription level policy assignment.

Parameters
- policyStatesSummaryResource: PolicyStatesSummaryResourceType
  
  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.
- subscriptionId: string
  
  Microsoft Azure subscription ID.
- policyAssignmentName: string
  
  Policy assignment name.
- Optional options: PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams
  
  The options parameters.
Returns Promise<PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: PolicyInsightsClient

Returns PolicyStatesImpl

Methods

beginTriggerResourceGroupEvaluation

Parameters

subscriptionId: string

resourceGroupName: string

Optional options: PolicyStatesTriggerResourceGroupEvaluationOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginTriggerResourceGroupEvaluationAndWait

Parameters

subscriptionId: string

resourceGroupName: string

Optional options: PolicyStatesTriggerResourceGroupEvaluationOptionalParams

Returns Promise<void>

beginTriggerSubscriptionEvaluation

Parameters

subscriptionId: string

Optional options: PolicyStatesTriggerSubscriptionEvaluationOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginTriggerSubscriptionEvaluationAndWait

Parameters

subscriptionId: string

Optional options: PolicyStatesTriggerSubscriptionEvaluationOptionalParams

Returns Promise<void>

listQueryResultsForManagementGroup

Parameters

policyStatesResource: PolicyStatesResource

managementGroupName: string

Optional options: PolicyStatesListQueryResultsForManagementGroupOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForPolicyDefinition

Parameters

policyStatesResource: PolicyStatesResource

subscriptionId: string

policyDefinitionName: string

Optional options: PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForPolicySetDefinition

Parameters

policyStatesResource: PolicyStatesResource

subscriptionId: string

policySetDefinitionName: string

Optional options: PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResource

Parameters

policyStatesResource: PolicyStatesResource

resourceId: string

Optional options: PolicyStatesListQueryResultsForResourceOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResourceGroup

Parameters

policyStatesResource: PolicyStatesResource

subscriptionId: string

resourceGroupName: string

Optional options: PolicyStatesListQueryResultsForResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForResourceGroupLevelPolicyAssignment

Parameters

policyStatesResource: PolicyStatesResource

subscriptionId: string

resourceGroupName: string

policyAssignmentName: string

Optional options: PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>

listQueryResultsForSubscription

Parameters

policyStatesResource: PolicyStatesResource

subscriptionId: string

Optional options: PolicyStatesListQueryResultsForSubscriptionOptionalParams

Returns PagedAsyncIterableIterator<PolicyState>