azure.mgmt.policyinsights.operations module¶
-
class
azure.mgmt.policyinsights.operations.
PolicyEventsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PolicyEventsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: - policy_events_resource – The name of the virtual resource under PolicyEvents resource type; only “default” is allowed. Constant value: “default”.
- management_groups_namespace – The namespace for Microsoft Management RP; only “Microsoft.Management” is allowed. Constant value: “Microsoft.Management”.
- api_version – API version to use with the client requests. Constant value: “2018-04-04”.
- authorization_namespace – The namespace for Microsoft Authorization resource provider; only “Microsoft.Authorization” is allowed. Constant value: “Microsoft.Authorization”.
-
get_metadata
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Gets OData metadata XML document.
Parameters: - scope (str) – A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
list_query_results_for_management_group
(management_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Queries policy events for the resources under the management group.
Parameters: - management_group_name (str) – Management group name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_policy_definition
(subscription_id, policy_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_policy_set_definition
(subscription_id, policy_set_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource
(resource_id, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Queries policy events for the resource.
Parameters: - resource_id (str) – Resource ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource_group
(subscription_id, resource_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource_group_level_policy_assignment
(subscription_id, resource_group_name, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_subscription
(subscription_id, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Queries policy events for the resources under the subscription.
Parameters: - subscription_id (str) – Microsoft Azure subscription ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_subscription_level_policy_assignment
(subscription_id, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyEventsQueryResults or ClientRawResponse if raw=true
Return type: PolicyEventsQueryResults or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.policyinsights.models' from '/usr/lib/python3/dist-packages/azure/mgmt/policyinsights/models/__init__.py'>¶
-
class
azure.mgmt.policyinsights.operations.
PolicyStatesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PolicyStatesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: - management_groups_namespace – The namespace for Microsoft Management RP; only “Microsoft.Management” is allowed. Constant value: “Microsoft.Management”.
- api_version – API version to use with the client requests. Constant value: “2018-04-04”.
- policy_states_summary_resource – 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. Constant value: “latest”.
- authorization_namespace – The namespace for Microsoft Authorization resource provider; only “Microsoft.Authorization” is allowed. Constant value: “Microsoft.Authorization”.
-
get_metadata
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Gets OData metadata XML document.
Parameters: - scope (str) – A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
list_query_results_for_management_group
(policy_states_resource, management_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- management_group_name (str) – Management group name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_policy_definition
(policy_states_resource, subscription_id, policy_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- policy_definition_name (str) – Policy definition name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_policy_set_definition
(policy_states_resource, subscription_id, policy_set_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- policy_set_definition_name (str) – Policy set definition name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource
(policy_states_resource, resource_id, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- resource_id (str) – Resource ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource_group
(policy_states_resource, subscription_id, resource_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- resource_group_name (str) – Resource group name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_resource_group_level_policy_assignment
(policy_states_resource, subscription_id, resource_group_name, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- resource_group_name (str) – Resource group name.
- policy_assignment_name (str) – Policy assignment name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_subscription
(policy_states_resource, subscription_id, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
list_query_results_for_subscription_level_policy_assignment
(policy_states_resource, subscription_id, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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). Possible values include: ‘default’, ‘latest’
- subscription_id (str) – Microsoft Azure subscription ID.
- policy_assignment_name (str) – Policy assignment name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PolicyStatesQueryResults or ClientRawResponse if raw=true
Return type: PolicyStatesQueryResults or ClientRawResponse
Raises:
-
summarize_for_management_group
(management_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Summarizes policy states for the resources under the management group.
Parameters: - management_group_name (str) – Management group name.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_policy_definition
(subscription_id, policy_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_policy_set_definition
(subscription_id, policy_set_definition_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_resource
(resource_id, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Summarizes policy states for the resource.
Parameters: - resource_id (str) – Resource ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_resource_group
(subscription_id, resource_group_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_resource_group_level_policy_assignment
(subscription_id, resource_group_name, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_subscription
(subscription_id, query_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Summarizes policy states for the resources under the subscription.
Parameters: - subscription_id (str) – Microsoft Azure subscription ID.
- query_options (QueryOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
summarize_for_subscription_level_policy_assignment
(subscription_id, policy_assignment_name, query_options=None, custom_headers=None, raw=False, **operation_config)[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) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SummarizeResults or ClientRawResponse if raw=true
Return type: SummarizeResults or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.policyinsights.models' from '/usr/lib/python3/dist-packages/azure/mgmt/policyinsights/models/__init__.py'>¶
-
class
azure.mgmt.policyinsights.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API version to use with the client requests. Constant value: “2018-04-04”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists available operations.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationsListResults or ClientRawResponse if raw=true
Return type: OperationsListResults or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.policyinsights.models' from '/usr/lib/python3/dist-packages/azure/mgmt/policyinsights/models/__init__.py'>¶