azure.mgmt.policyinsights.operations module¶

begin_create_or_update_at_resource_group(resource_group_name: str, attestation_name: str, parameters: ‘_models.Attestation’, **kwargs: Any) → LROPoller[‘_models.Attestation’][source]¶

Creates or updates an attestation at resource group scope.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
attestation_name (str) – The name of the attestation.
parameters (Attestation) – The attestation parameters.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Attestation]

Raises

begin_create_or_update_at_subscription(attestation_name: str, parameters: ‘_models.Attestation’, **kwargs: Any) → LROPoller[‘_models.Attestation’][source]¶

Creates or updates an attestation at subscription scope.

Parameters

attestation_name (str) – The name of the attestation.
parameters (Attestation) – The attestation parameters.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Attestation]

Raises

ItemPaged[AttestationListResult]

delete_at_resource(resource_id: str, attestation_name: str, **kwargs: Any) → None [source]¶

Deletes an existing attestation at individual resource scope.

Parameters

resource_id (str) – Resource ID.
attestation_name (str) – The name of the attestation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

delete_at_resource_group(resource_group_name: str, attestation_name: str, **kwargs: Any) → None [source]¶

Deletes an existing attestation at resource group scope.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
attestation_name (str) – The name of the attestation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

delete_at_subscription(attestation_name: str, **kwargs: Any) → None [source]¶

Deletes an existing attestation at subscription scope.

Parameters: attestation_name (str) – The name of the attestation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get_at_resource(resource_id: str, attestation_name: str, **kwargs: Any) → _models.Attestation[source]¶

Gets an existing attestation at resource scope.

Parameters

resource_id (str) – Resource ID.
attestation_name (str) – The name of the attestation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Attestation, or the result of cls(response)

Return type

Attestation

Raises

~azure.core.exceptions.HttpResponseError

get_at_resource_group(resource_group_name: str, attestation_name: str, **kwargs: Any) → _models.Attestation[source]¶

Gets an existing attestation at resource group scope.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
attestation_name (str) – The name of the attestation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Attestation, or the result of cls(response)

Return type

Attestation

Raises

~azure.core.exceptions.HttpResponseError

get_at_subscription(attestation_name: str, **kwargs: Any) → _models.Attestation[source]¶

Gets an existing attestation at subscription scope.

Parameters: attestation_name (str) – The name of the attestation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Attestation, or the result of cls(response)
Return type: Attestation
Raises: ~azure.core.exceptions.HttpResponseError

list_for_resource(resource_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.AttestationListResult’][source]¶

Gets all attestations for a resource.

Parameters

resource_id (str) – Resource ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_for_resource_group(resource_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.AttestationListResult’][source]¶

Gets all attestations for the resource group.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AttestationListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_for_subscription(query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.AttestationListResult’][source]¶

Gets all attestations for the subscription.

Parameters: query_options (QueryOptions) – Parameter group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AttestationListResult or the result of cls(response)
Return type: ItemPaged[AttestationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → _models.OperationsListResults[source]¶

Lists available operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: OperationsListResults, or the result of cls(response)
Return type: OperationsListResults
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.PolicyEventsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyEventsOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_query_results_for_management_group(management_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the resources under the management group.

Parameters

management_group_name (str) – Management group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_policy_definition(subscription_id: str, policy_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the subscription level policy definition.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_definition_name (str) – Policy definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_policy_set_definition(subscription_id: str, policy_set_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the subscription level policy set definition.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_set_definition_name (str) – Policy set definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource(resource_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the resource.

Parameters

resource_id (str) – Resource ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource_group(subscription_id: str, resource_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the resources under the resource group.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource_group_level_policy_assignment(subscription_id: str, resource_group_name: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the resource group level policy assignment.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_subscription(subscription_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the resources under the subscription.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_subscription_level_policy_assignment(subscription_id: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyEventsQueryResults’][source]¶

Queries policy events for the subscription level policy assignment.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.PolicyMetadataOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyMetadataOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get_resource(resource_name: str, **kwargs: Any) → _models.PolicyMetadata[source]¶

Get policy metadata resource.

Parameters: resource_name (str) – The name of the policy metadata resource.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: PolicyMetadata, or the result of cls(response)
Return type: PolicyMetadata
Raises: ~azure.core.exceptions.HttpResponseError

list(query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyMetadataCollection’][source]¶

Get a list of the policy metadata resources.

Parameters: query_options (QueryOptions) – Parameter group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PolicyMetadataCollection or the result of cls(response)
Return type: ItemPaged[PolicyMetadataCollection]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.PolicyRestrictionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyRestrictionsOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_at_resource_group_scope(resource_group_name: str, parameters: ‘_models.CheckRestrictionsRequest’, **kwargs: Any) → _models.CheckRestrictionsResult[source]¶

Checks what restrictions Azure Policy will place on a resource within a resource group. Use this when the resource group the resource will be created in is already known.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
parameters (CheckRestrictionsRequest) – The check policy restrictions parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckRestrictionsResult, or the result of cls(response)

Return type

CheckRestrictionsResult

Raises

~azure.core.exceptions.HttpResponseError

check_at_subscription_scope(parameters: ‘_models.CheckRestrictionsRequest’, **kwargs: Any) → _models.CheckRestrictionsResult[source]¶

Checks what restrictions Azure Policy will place on a resource within a subscription.

Parameters: parameters (CheckRestrictionsRequest) – The check policy restrictions parameters.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: CheckRestrictionsResult, or the result of cls(response)
Return type: CheckRestrictionsResult
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.PolicyStatesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_trigger_resource_group_evaluation(subscription_id: str, resource_group_name: str, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

begin_trigger_subscription_evaluation(subscription_id: str, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

subscription_id (str) – Microsoft Azure subscription ID.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

list_query_results_for_management_group(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], management_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the resources under the management group.

Parameters

policy_states_resource (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 (str) – Management group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_policy_definition(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, policy_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the subscription level policy definition.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
policy_definition_name (str) – Policy definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_policy_set_definition(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, policy_set_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the subscription level policy set definition.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
policy_set_definition_name (str) – Policy set definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], resource_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the resource.

Parameters

policy_states_resource (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 (str) – Resource ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource_group(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, resource_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the resources under the resource group.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource_group_level_policy_assignment(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, resource_group_name: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the resource group level policy assignment.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_subscription(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the resources under the subscription.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_subscription_level_policy_assignment(policy_states_resource: Union[str, ‘_models.PolicyStatesResource’], subscription_id: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyStatesQueryResults’][source]¶

Queries policy states for the subscription level policy assignment.

Parameters

policy_states_resource (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 (str) – Microsoft Azure subscription ID.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_management_group(management_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the resources under the management group.

Parameters

management_group_name (str) – Management group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_policy_definition(subscription_id: str, policy_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the subscription level policy definition.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_definition_name (str) – Policy definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_policy_set_definition(subscription_id: str, policy_set_definition_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the subscription level policy set definition.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_set_definition_name (str) – Policy set definition name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_resource(resource_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the resource.

Parameters

resource_id (str) – Resource ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_resource_group(subscription_id: str, resource_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the resources under the resource group.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_resource_group_level_policy_assignment(subscription_id: str, resource_group_name: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the resource group level policy assignment.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
resource_group_name (str) – Resource group name.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_subscription(subscription_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the resources under the subscription.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

summarize_for_subscription_level_policy_assignment(subscription_id: str, policy_assignment_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → _models.SummarizeResults[source]¶

Summarizes policy states for the subscription level policy assignment.

Parameters

subscription_id (str) – Microsoft Azure subscription ID.
policy_assignment_name (str) – Policy assignment name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SummarizeResults, or the result of cls(response)

Return type

ItemPaged[PolicyTrackedResourcesQueryResults]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.PolicyTrackedResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyTrackedResourcesOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_query_results_for_management_group(management_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyTrackedResourcesQueryResults’][source]¶

Queries policy tracked resources under the management group.

Parameters

management_group_name (str) – Management group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource(resource_id: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyTrackedResourcesQueryResults’][source]¶

Queries policy tracked resources under the resource.

Parameters

resource_id (str) – Resource ID.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PolicyTrackedResourcesQueryResults]

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_resource_group(resource_group_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyTrackedResourcesQueryResults’][source]¶

Queries policy tracked resources under the resource group.

Parameters

resource_group_name (str) – Resource group name.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PolicyTrackedResourcesQueryResults]

Raises

~azure.core.exceptions.HttpResponseError

list_query_results_for_subscription(query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.PolicyTrackedResourcesQueryResults’][source]¶

Queries policy tracked resources under the subscription.

Parameters: query_options (QueryOptions) – Parameter group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PolicyTrackedResourcesQueryResults or the result of cls(response)
Return type: ItemPaged[PolicyTrackedResourcesQueryResults]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.policyinsights.models' from '/mnt/vss/_work/1/s/sdk/policyinsights/azure-mgmt-policyinsights/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/policyinsights/models/__init__.py'>¶

class azure.mgmt.policyinsights.operations.RemediationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RemediationsOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

cancel_at_management_group(management_group_id: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Cancels a remediation at management group scope.

Parameters

management_group_id (str) – Management group ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

cancel_at_resource(resource_id: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Cancel a remediation at resource scope.

Parameters

resource_id (str) – Resource ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

cancel_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Cancels a remediation at resource group scope.

Parameters

resource_group_name (str) – Resource group name.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

cancel_at_subscription(remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Cancels a remediation at subscription scope.

Parameters: remediation_name (str) – The name of the remediation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Remediation, or the result of cls(response)
Return type: Remediation
Raises: ~azure.core.exceptions.HttpResponseError

create_or_update_at_management_group(management_group_id: str, remediation_name: str, parameters: ‘_models.Remediation’, **kwargs: Any) → _models.Remediation[source]¶

Creates or updates a remediation at management group scope.

Parameters

management_group_id (str) – Management group ID.
remediation_name (str) – The name of the remediation.
parameters (Remediation) – The remediation parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update_at_resource(resource_id: str, remediation_name: str, parameters: ‘_models.Remediation’, **kwargs: Any) → _models.Remediation[source]¶

Creates or updates a remediation at resource scope.

Parameters

resource_id (str) – Resource ID.
remediation_name (str) – The name of the remediation.
parameters (Remediation) – The remediation parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update_at_resource_group(resource_group_name: str, remediation_name: str, parameters: ‘_models.Remediation’, **kwargs: Any) → _models.Remediation[source]¶

Creates or updates a remediation at resource group scope.

Parameters

resource_group_name (str) – Resource group name.
remediation_name (str) – The name of the remediation.
parameters (Remediation) – The remediation parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update_at_subscription(remediation_name: str, parameters: ‘_models.Remediation’, **kwargs: Any) → _models.Remediation[source]¶

Creates or updates a remediation at subscription scope.

Parameters

remediation_name (str) – The name of the remediation.
parameters (Remediation) – The remediation parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete_at_management_group(management_group_id: str, remediation_name: str, **kwargs: Any) → Optional[‘_models.Remediation’][source]¶

Deletes an existing remediation at management group scope.

Parameters

management_group_id (str) – Management group ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Remediation or None

Raises

~azure.core.exceptions.HttpResponseError

delete_at_resource(resource_id: str, remediation_name: str, **kwargs: Any) → Optional[‘_models.Remediation’][source]¶

Deletes an existing remediation at individual resource scope.

Parameters

resource_id (str) – Resource ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Remediation or None

Raises

~azure.core.exceptions.HttpResponseError

delete_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs: Any) → Optional[‘_models.Remediation’][source]¶

Deletes an existing remediation at resource group scope.

Parameters

resource_group_name (str) – Resource group name.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Remediation or None

Raises

~azure.core.exceptions.HttpResponseError

delete_at_subscription(remediation_name: str, **kwargs: Any) → Optional[‘_models.Remediation’][source]¶

Deletes an existing remediation at subscription scope.

Parameters: remediation_name (str) – The name of the remediation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Remediation, or the result of cls(response)
Return type: Remediation or None
Raises: ~azure.core.exceptions.HttpResponseError

get_at_management_group(management_group_id: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Gets an existing remediation at management group scope.

Parameters

management_group_id (str) – Management group ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_at_resource(resource_id: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Gets an existing remediation at resource scope.

Parameters

resource_id (str) – Resource ID.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Gets an existing remediation at resource group scope.

Parameters

resource_group_name (str) – Resource group name.
remediation_name (str) – The name of the remediation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Remediation, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_at_subscription(remediation_name: str, **kwargs: Any) → _models.Remediation[source]¶

Gets an existing remediation at subscription scope.

Parameters: remediation_name (str) – The name of the remediation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Remediation, or the result of cls(response)
Return type: Remediation
Raises: ~azure.core.exceptions.HttpResponseError

list_deployments_at_management_group(management_group_id: str, remediation_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.RemediationDeploymentsListResult’][source]¶

Gets all deployments for a remediation at management group scope.

Parameters

management_group_id (str) – Management group ID.
remediation_name (str) – The name of the remediation.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_deployments_at_resource(resource_id: str, remediation_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.RemediationDeploymentsListResult’][source]¶

Gets all deployments for a remediation at resource scope.

Parameters

resource_id (str) – Resource ID.
remediation_name (str) – The name of the remediation.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_deployments_at_resource_group(resource_group_name: str, remediation_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.RemediationDeploymentsListResult’][source]¶

Gets all deployments for a remediation at resource group scope.

Parameters

resource_group_name (str) – Resource group name.
remediation_name (str) – The name of the remediation.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_deployments_at_subscription(remediation_name: str, query_options: Optional[‘_models.QueryOptions’] = None, **kwargs: Any) → Iterable[‘_models.RemediationDeploymentsListResult’][source]¶

Gets all deployments for a remediation at subscription scope.

Parameters

remediation_name (str) – The name of the remediation.
query_options (QueryOptions) – Parameter group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type