Share via

PolicyStatesOperations Class

  • Reference

PolicyStatesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
PolicyStatesOperations

Constructor

PolicyStatesOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_trigger_resource_group_evaluation

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

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

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

Queries policy states for the subscription level policy definition.
list_query_results_for_policy_set_definition

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

Queries policy states for the resource.
list_query_results_for_resource_group

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

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

Queries policy states for the resources under the subscription.
list_query_results_for_subscription_level_policy_assignment

Queries policy states for the subscription level policy assignment.
summarize_for_management_group

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

Summarizes policy states for the subscription level policy definition.
summarize_for_policy_set_definition

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

Summarizes policy states for the resource.
summarize_for_resource_group

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

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

Summarizes policy states for the resources under the subscription.
summarize_for_subscription_level_policy_assignment

Summarizes policy states for the subscription level policy assignment.

begin_trigger_resource_group_evaluation

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

begin_trigger_resource_group_evaluation(subscription_id: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
resource_group_name
Required
str

Resource group name.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_trigger_subscription_evaluation

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

begin_trigger_subscription_evaluation(subscription_id: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_management_group

Queries policy states for the resources under the management group.

list_query_results_for_management_group(policy_states_resource: str | '_models.PolicyStatesResource', management_group_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
management_group_name
Required
str

Management group name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_policy_definition

Queries policy states for the subscription level policy definition.

list_query_results_for_policy_definition(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, policy_definition_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_definition_name
Required
str

Policy definition name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_policy_set_definition

Queries policy states for the subscription level policy set definition.

list_query_results_for_policy_set_definition(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, policy_set_definition_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_set_definition_name
Required
str

Policy set definition name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_resource

Queries policy states for the resource.

list_query_results_for_resource(policy_states_resource: str | '_models.PolicyStatesResource', resource_id: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
resource_id
Required
str

Resource ID.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_resource_group

Queries policy states for the resources under the resource group.

list_query_results_for_resource_group(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, resource_group_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
resource_group_name
Required
str

Resource group name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_resource_group_level_policy_assignment

Queries policy states for the resource group level policy assignment.

list_query_results_for_resource_group_level_policy_assignment(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, resource_group_name: str, policy_assignment_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
resource_group_name
Required
str

Resource group name.
policy_assignment_name
Required
str

Policy assignment name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_subscription

Queries policy states for the resources under the subscription.

list_query_results_for_subscription(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_query_results_for_subscription_level_policy_assignment

Queries policy states for the subscription level policy assignment.

list_query_results_for_subscription_level_policy_assignment(policy_states_resource: str | '_models.PolicyStatesResource', subscription_id: str, policy_assignment_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> Iterable['_models.PolicyStatesQueryResults']

Parameters

Name Description
policy_states_resource
Required
str or 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).
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_assignment_name
Required
str

Policy assignment name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[PolicyStatesQueryResults]

An iterator like instance of either PolicyStatesQueryResults or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_management_group

Summarizes policy states for the resources under the management group.

summarize_for_management_group(management_group_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
management_group_name
Required
str

Management group name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_policy_definition

Summarizes policy states for the subscription level policy definition.

summarize_for_policy_definition(subscription_id: str, policy_definition_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_definition_name
Required
str

Policy definition name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_policy_set_definition

Summarizes policy states for the subscription level policy set definition.

summarize_for_policy_set_definition(subscription_id: str, policy_set_definition_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_set_definition_name
Required
str

Policy set definition name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_resource

Summarizes policy states for the resource.

summarize_for_resource(resource_id: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
resource_id
Required
str

Resource ID.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_resource_group

Summarizes policy states for the resources under the resource group.

summarize_for_resource_group(subscription_id: str, resource_group_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
resource_group_name
Required
str

Resource group name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_resource_group_level_policy_assignment

Summarizes policy states for the resource group level policy assignment.

summarize_for_resource_group_level_policy_assignment(subscription_id: str, resource_group_name: str, policy_assignment_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
resource_group_name
Required
str

Resource group name.
policy_assignment_name
Required
str

Policy assignment name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_subscription

Summarizes policy states for the resources under the subscription.

summarize_for_subscription(subscription_id: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

summarize_for_subscription_level_policy_assignment

Summarizes policy states for the subscription level policy assignment.

summarize_for_subscription_level_policy_assignment(subscription_id: str, policy_assignment_name: str, query_options: '_models.QueryOptions' | None = None, **kwargs: Any) -> _models.SummarizeResults

Parameters

Name Description
subscription_id
Required
str

Microsoft Azure subscription ID.
policy_assignment_name
Required
str

Policy assignment name.
query_options
QueryOptions

Parameter group.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SummarizeResults

SummarizeResults, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.policyinsights.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\policyinsights\\models\\__init__.py'>