PolicyStates interface
Interface representing a PolicyStates.
Methods
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.
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.
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.
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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
summarizeForManagementGroup(string, string, PolicyStatesSummarizeForManagementGroupOptionalParams)
Summarizes policy states for the resources under the management group.
function summarizeForManagementGroup(policyStatesSummaryResource: string, managementGroupName: string, options?: PolicyStatesSummarizeForManagementGroupOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForPolicyDefinition(string, string, string, PolicyStatesSummarizeForPolicyDefinitionOptionalParams)
Summarizes policy states for the subscription level policy definition.
function summarizeForPolicyDefinition(policyStatesSummaryResource: string, subscriptionId: string, policyDefinitionName: string, options?: PolicyStatesSummarizeForPolicyDefinitionOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForPolicySetDefinition(string, string, string, PolicyStatesSummarizeForPolicySetDefinitionOptionalParams)
Summarizes policy states for the subscription level policy set definition.
function summarizeForPolicySetDefinition(policyStatesSummaryResource: string, subscriptionId: string, policySetDefinitionName: string, options?: PolicyStatesSummarizeForPolicySetDefinitionOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForResource(string, string, PolicyStatesSummarizeForResourceOptionalParams)
Summarizes policy states for the resource.
function summarizeForResource(policyStatesSummaryResource: string, resourceId: string, options?: PolicyStatesSummarizeForResourceOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForResourceGroup(string, string, string, PolicyStatesSummarizeForResourceGroupOptionalParams)
Summarizes policy states for the resources under the resource group.
function summarizeForResourceGroup(policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, options?: PolicyStatesSummarizeForResourceGroupOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForResourceGroupLevelPolicyAssignment(string, string, string, string, PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams)
Summarizes policy states for the resource group level policy assignment.
function summarizeForResourceGroupLevelPolicyAssignment(policyStatesSummaryResource: string, subscriptionId: string, resourceGroupName: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForSubscription(string, string, PolicyStatesSummarizeForSubscriptionOptionalParams)
Summarizes policy states for the resources under the subscription.
function summarizeForSubscription(policyStatesSummaryResource: string, subscriptionId: string, options?: PolicyStatesSummarizeForSubscriptionOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
summarizeForSubscriptionLevelPolicyAssignment(string, string, string, PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams)
Summarizes policy states for the subscription level policy assignment.
function summarizeForSubscriptionLevelPolicyAssignment(policyStatesSummaryResource: string, subscriptionId: string, policyAssignmentName: string, options?: PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams): Promise<SummarizeResults>Parameters
- policyStatesSummaryResource
-
string
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.
The options parameters.
Returns
Promise<SummarizeResults>
Azure SDK for JavaScript