azure.mgmt.monitor.operations module¶
-
class
azure.mgmt.monitor.operations.
AutoscaleSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AutoscaleSettingsOperations 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 – Client Api Version. Constant value: “2015-04-01”.
-
create_or_update
(resource_group_name, autoscale_setting_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates an autoscale setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- autoscale_setting_name (str) – The autoscale setting name.
- parameters (AutoscaleSettingResource) – Parameters supplied to 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: AutoscaleSettingResource or ClientRawResponse if raw=true
Return type: AutoscaleSettingResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, autoscale_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes and autoscale setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- autoscale_setting_name (str) – The autoscale setting name.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, autoscale_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an autoscale setting.
Parameters: - resource_group_name (str) – The name of the resource group.
- autoscale_setting_name (str) – The autoscale setting name.
- 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: AutoscaleSettingResource or ClientRawResponse if raw=true
Return type: AutoscaleSettingResource or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the autoscale settings for a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- 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: An iterator like instance of AutoscaleSettingResource
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, autoscale_setting_name, autoscale_setting_resource, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.
Parameters: - resource_group_name (str) – The name of the resource group.
- autoscale_setting_name (str) – The autoscale setting name.
- autoscale_setting_resource (AutoscaleSettingResourcePatch) – Parameters supplied to 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: AutoscaleSettingResource or ClientRawResponse if raw=true
Return type: AutoscaleSettingResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.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 – Client Api Version. Constant value: “2015-04-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available operations from Microsoft.Insights provider.
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: OperationListResult or ClientRawResponse if raw=true
Return type: OperationListResult or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
AlertRuleIncidentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AlertRuleIncidentsOperations 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 – Client Api Version. Constant value: “2016-03-01”.
-
get
(resource_group_name, rule_name, incident_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an incident associated to an alert rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- incident_name (str) – The name of the incident to retrieve.
- 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: Incident or ClientRawResponse if raw=true
Return type: Incident or ClientRawResponse
Raises:
-
list_by_alert_rule
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of incidents associated to an alert rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: An iterator like instance of Incident
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
AlertRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AlertRulesOperations 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 – Client Api Version. Constant value: “2016-03-01”.
-
create_or_update
(resource_group_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates an alert rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- parameters (AlertRuleResource) – The parameters of the rule to create or update.
- 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: AlertRuleResource or ClientRawResponse if raw=true
Return type: AlertRuleResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an alert rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an alert rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: AlertRuleResource or ClientRawResponse if raw=true
Return type: AlertRuleResource or ClientRawResponse
Raises: CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ List the alert rules within a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- 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: An iterator like instance of AlertRuleResource
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, rule_name, alert_rules_resource, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an existing AlertRuleResource. To update other fields use the CreateOrUpdate method.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- alert_rules_resource (AlertRuleResourcePatch) – Parameters supplied to 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: AlertRuleResource or ClientRawResponse if raw=true
Return type: AlertRuleResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.operations.
LogProfilesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LogProfilesOperations 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 – Client Api Version. Constant value: “2016-03-01”.
-
create_or_update
(log_profile_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Create or update a log profile in Azure Monitoring REST API.
Parameters: - log_profile_name (str) – The name of the log profile.
- parameters (LogProfileResource) – Parameters supplied to 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: LogProfileResource or ClientRawResponse if raw=true
Return type: LogProfileResource or ClientRawResponse
Raises: CloudError
-
delete
(log_profile_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the log profile.
Parameters: - log_profile_name (str) – The name of the log profile.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(log_profile_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the log profile.
Parameters: - log_profile_name (str) – The name of the log profile.
- 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: LogProfileResource or ClientRawResponse if raw=true
Return type: LogProfileResource or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List the log profiles.
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: An iterator like instance of LogProfileResource
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(log_profile_name, log_profiles_resource, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an existing LogProfilesResource. To update other fields use the CreateOrUpdate method.
Parameters: - log_profile_name (str) – The name of the log profile.
- log_profiles_resource (LogProfileResourcePatch) – Parameters supplied to 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: LogProfileResource or ClientRawResponse if raw=true
Return type: LogProfileResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.operations.
DiagnosticSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DiagnosticSettingsOperations 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 – Client Api Version. Constant value: “2017-05-01-preview”.
-
create_or_update
(resource_uri, parameters, name, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates diagnostic settings for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- parameters (DiagnosticSettingsResource) – Parameters supplied to the operation.
- name (str) – The name of the diagnostic setting.
- 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: DiagnosticSettingsResource or ClientRawResponse if raw=true
Return type: DiagnosticSettingsResource or ClientRawResponse
Raises:
-
delete
(resource_uri, name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes existing diagnostic settings for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- name (str) – The name of the diagnostic setting.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_uri, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the active diagnostic settings for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- name (str) – The name of the diagnostic setting.
- 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: DiagnosticSettingsResource or ClientRawResponse if raw=true
Return type: DiagnosticSettingsResource or ClientRawResponse
Raises:
-
list
(resource_uri, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the active diagnostic settings list for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- 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: DiagnosticSettingsResourceCollection or ClientRawResponse if raw=true
Return type: DiagnosticSettingsResourceCollection or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
DiagnosticSettingsCategoryOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DiagnosticSettingsCategoryOperations 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 – Client Api Version. Constant value: “2017-05-01-preview”.
-
get
(resource_uri, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the diagnostic settings category for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- name (str) – The name of the diagnostic setting.
- 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: DiagnosticSettingsCategoryResource or ClientRawResponse if raw=true
Return type: DiagnosticSettingsCategoryResource or ClientRawResponse
Raises:
-
list
(resource_uri, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the diagnostic settings categories for the specified resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- 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: DiagnosticSettingsCategoryResourceCollection or ClientRawResponse if raw=true
Return type: DiagnosticSettingsCategoryResourceCollection or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
ActionGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ActionGroupsOperations 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 – Client Api Version. Constant value: “2018-03-01”.
-
create_or_update
(resource_group_name, action_group_name, action_group, custom_headers=None, raw=False, **operation_config)[source]¶ Create a new action group or update an existing one.
Parameters: - resource_group_name (str) – The name of the resource group.
- action_group_name (str) – The name of the action group.
- action_group (ActionGroupResource) – The action group to create or use for the update.
- 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: ActionGroupResource or ClientRawResponse if raw=true
Return type: ActionGroupResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, action_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete an action group.
Parameters: - resource_group_name (str) – The name of the resource group.
- action_group_name (str) – The name of the action group.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
enable_receiver
(resource_group_name, action_group_name, receiver_name, custom_headers=None, raw=False, **operation_config)[source]¶ Enable a receiver in an action group. This changes the receiver’s status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.
Parameters: - resource_group_name (str) – The name of the resource group.
- action_group_name (str) – The name of the action group.
- receiver_name (str) – The name of the receiver to resubscribe.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, action_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get an action group.
Parameters: - resource_group_name (str) – The name of the resource group.
- action_group_name (str) – The name of the action group.
- 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: ActionGroupResource or ClientRawResponse if raw=true
Return type: ActionGroupResource or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a list of all action groups in a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- 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: An iterator like instance of ActionGroupResource
Return type: Raises:
-
list_by_subscription_id
(custom_headers=None, raw=False, **operation_config)[source]¶ Get a list of all action groups in a subscription.
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: An iterator like instance of ActionGroupResource
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, action_group_name, tags=None, enabled=True, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an existing action group’s tags. To update other fields use the CreateOrUpdate method.
Parameters: - resource_group_name (str) – The name of the resource group.
- action_group_name (str) – The name of the action group.
- tags (dict[str, str]) – Resource tags
- enabled (bool) – Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated.
- 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: ActionGroupResource or ClientRawResponse if raw=true
Return type: ActionGroupResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.operations.
ActivityLogAlertsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ActivityLogAlertsOperations 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 – Client Api Version. Constant value: “2017-04-01”.
-
create_or_update
(resource_group_name, activity_log_alert_name, activity_log_alert, custom_headers=None, raw=False, **operation_config)[source]¶ Create a new activity log alert or update an existing one.
Parameters: - resource_group_name (str) – The name of the resource group.
- activity_log_alert_name (str) – The name of the activity log alert.
- activity_log_alert (ActivityLogAlertResource) – The activity log alert to create or use for the update.
- 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: ActivityLogAlertResource or ClientRawResponse if raw=true
Return type: ActivityLogAlertResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, activity_log_alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete an activity log alert.
Parameters: - resource_group_name (str) – The name of the resource group.
- activity_log_alert_name (str) – The name of the activity log alert.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, activity_log_alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get an activity log alert.
Parameters: - resource_group_name (str) – The name of the resource group.
- activity_log_alert_name (str) – The name of the activity log alert.
- 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: ActivityLogAlertResource or ClientRawResponse if raw=true
Return type: ActivityLogAlertResource or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a list of all activity log alerts in a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- 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: An iterator like instance of ActivityLogAlertResource
Return type: Raises:
-
list_by_subscription_id
(custom_headers=None, raw=False, **operation_config)[source]¶ Get a list of all activity log alerts in a subscription.
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: An iterator like instance of ActivityLogAlertResource
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, activity_log_alert_name, tags=None, enabled=True, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an existing ActivityLogAlertResource’s tags. To update other fields use the CreateOrUpdate method.
Parameters: - resource_group_name (str) – The name of the resource group.
- activity_log_alert_name (str) – The name of the activity log alert.
- tags (dict[str, str]) – Resource tags
- enabled (bool) – Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated.
- 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: ActivityLogAlertResource or ClientRawResponse if raw=true
Return type: ActivityLogAlertResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.operations.
ActivityLogsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ActivityLogsOperations 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 – Client Api Version. Constant value: “2015-04-01”.
-
list
(filter=None, select=None, custom_headers=None, raw=False, **operation_config)[source]¶ Provides the list of records from the activity logs.
Parameters: - filter (str) – Reduces the set of data collected.<br>The $filter argument is very restricted and allows only the following patterns.<br>- List events for a resource group: $filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’ and resourceGroupName eq ‘resourceGroupName’.<br>- List events for resource: $filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’ and resourceUri eq ‘resourceURI’.<br>- List events for a subscription in a time range: $filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’.<br>- List events for a resource provider: $filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’ and resourceProvider eq ‘resourceProviderName’.<br>- List events for a correlation Id: $filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’ and correlationId eq ‘correlationID’.<br><br>**NOTE**: No other syntax is allowed.
- select (str) – Used to fetch events with only the given properties.<br>The $select argument is a comma separated list of property names to be returned. Possible values are: authorization, claims, correlationId, description, eventDataId, eventName, eventTimestamp, httpRequest, level, operationId, operationName, properties, resourceGroupName, resourceProviderName, resourceId, status, submissionTimestamp, subStatus, subscriptionId
- 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: An iterator like instance of EventData
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
EventCategoriesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
EventCategoriesOperations 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 – Client Api Version. Constant value: “2015-04-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get the list of available event categories supported in the Activity Logs Service.<br>The current list includes the following: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy.
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: An iterator like instance of LocalizableString
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
TenantActivityLogsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TenantActivityLogsOperations 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 – Client Api Version. Constant value: “2015-04-01”.
-
list
(filter=None, select=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Activity Logs for the Tenant.<br>Everything that is applicable to the API to get the Activity Logs for the subscription is applicable to this API (the parameters, $filter, etc.).<br>One thing to point out here is that this API does not retrieve the logs at the individual subscription of the tenant but only surfaces the logs that were generated at the tenant level.
Parameters: - filter (str) – Reduces the set of data collected. <br>The $filter is very restricted and allows only the following patterns.<br>- List events for a resource group: $filter=eventTimestamp ge ‘<Start Time>’ and eventTimestamp le ‘<End Time>’ and eventChannels eq ‘Admin, Operation’ and resourceGroupName eq ‘<ResourceGroupName>’.<br>- List events for resource: $filter=eventTimestamp ge ‘<Start Time>’ and eventTimestamp le ‘<End Time>’ and eventChannels eq ‘Admin, Operation’ and resourceUri eq ‘<ResourceURI>’.<br>- List events for a subscription: $filter=eventTimestamp ge ‘<Start Time>’ and eventTimestamp le ‘<End Time>’ and eventChannels eq ‘Admin, Operation’.<br>- List events for a resource provider: $filter=eventTimestamp ge ‘<Start Time>’ and eventTimestamp le ‘<End Time>’ and eventChannels eq ‘Admin, Operation’ and resourceProvider eq ‘<ResourceProviderName>’.<br>- List events for a correlation Id: api-version=2014-04-01&$filter=eventTimestamp ge ‘2014-07-16T04:36:37.6407898Z’ and eventTimestamp le ‘2014-07-20T04:36:37.6407898Z’ and eventChannels eq ‘Admin, Operation’ and correlationId eq ‘<CorrelationID>’.<br>**NOTE**: No other syntax is allowed.
- select (str) – Used to fetch events with only the given properties.<br>The $select argument is a comma separated list of property names to be returned. Possible values are: authorization, claims, correlationId, description, eventDataId, eventName, eventTimestamp, httpRequest, level, operationId, operationName, properties, resourceGroupName, resourceProviderName, resourceId, status, submissionTimestamp, subStatus, subscriptionId
- 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: An iterator like instance of EventData
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
MetricDefinitionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MetricDefinitionsOperations 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 – Client Api Version. Constant value: “2018-01-01”.
-
list
(resource_uri, metricnamespace=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the metric definitions for the resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- metricnamespace (str) – Metric namespace to query metric definitions for.
- 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: An iterator like instance of MetricDefinition
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
MetricsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MetricsOperations 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 – Client Api Version. Constant value: “2018-01-01”.
-
list
(resource_uri, timespan=None, interval=None, metricnames=None, aggregation=None, top=None, orderby=None, filter=None, result_type=None, metricnamespace=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the metric values for a resource.
Parameters: - resource_uri (str) – The identifier of the resource.
- timespan (str) – The timespan of the query. It is a string with the following format ‘startDateTime_ISO/endDateTime_ISO’.
- interval (timedelta) – The interval (i.e. timegrain) of the query.
- metricnames (str) – The names of the metrics (comma separated) to retrieve.
- aggregation (str) – The list of aggregation types (comma separated) to retrieve.
- top (int) – The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10.
- orderby (str) – The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc.
- filter (str) – The $filter is used to reduce the set of metric data returned.<br>Example:<br>Metric contains metadata A, B and C.<br>- Return all time series of C where A = a1 and B = b1 or b2<br>**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’<br>- Invalid variant:<br>**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**<br>This is invalid because the logical or operator cannot separate two different metadata names.<br>- Return all time series where A = a1, B = b1 and C = c1:<br>**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**<br>- Return all time series where A = a1<br>**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’.
- result_type (str or ResultType) – Reduces the set of data collected. The syntax allowed depends on the operation. See the operation’s description for details. Possible values include: ‘Data’, ‘Metadata’
- metricnamespace (str) – Metric namespace to query metric definitions for.
- 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: Response or ClientRawResponse if raw=true
Return type: Response or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
MetricBaselineOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MetricBaselineOperations 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 – Client Api Version. Constant value: “2017-11-01-preview”.
-
calculate_baseline
(resource_uri, time_series_information, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the baseline values for a resource.
Parameters: - resource_uri (str) – The identifier of the resource. It has the following structure: subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceName}. For example: subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1
- time_series_information (TimeSeriesInformation) – Information that need to be specified to calculate a baseline on a time series.
- 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: CalculateBaselineResponse or ClientRawResponse if raw=true
Return type: CalculateBaselineResponse or ClientRawResponse
Raises:
-
get
(resource_uri, metric_name, timespan=None, interval=None, aggregation=None, sensitivities=None, result_type=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the baseline values for a specific metric.
Parameters: - resource_uri (str) – The identifier of the resource. It has the following structure: subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceName}. For example: subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1
- metric_name (str) – The name of the metric to retrieve the baseline for.
- timespan (str) – The timespan of the query. It is a string with the following format ‘startDateTime_ISO/endDateTime_ISO’.
- interval (timedelta) – The interval (i.e. timegrain) of the query.
- aggregation (str) – The aggregation type of the metric to retrieve the baseline for.
- sensitivities (str) – The list of sensitivities (comma separated) to retrieve.
- result_type (str or ResultType) – Allows retrieving only metadata of the baseline. On data request all information is retrieved. Possible values include: ‘Data’, ‘Metadata’
- 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: BaselineResponse or ClientRawResponse if raw=true
Return type: BaselineResponse or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
MetricAlertsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MetricAlertsOperations 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 – Client Api Version. Constant value: “2018-03-01”.
-
create_or_update
(resource_group_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Create or update an metric alert definition.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- parameters (MetricAlertResource) – The parameters of the rule to create or update.
- 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: MetricAlertResource or ClientRawResponse if raw=true
Return type: MetricAlertResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete an alert rule defitiniton.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve an alert rule definiton.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: MetricAlertResource or ClientRawResponse if raw=true
Return type: MetricAlertResource or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve alert rule defintions in a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- 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: An iterator like instance of MetricAlertResource
Return type: Raises:
-
list_by_subscription
(custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve alert rule definitions in a subscription.
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: An iterator like instance of MetricAlertResource
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Update an metric alert definition.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- parameters (MetricAlertResourcePatch) – The parameters of the rule to update.
- 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: MetricAlertResource or ClientRawResponse if raw=true
Return type: MetricAlertResource or ClientRawResponse
Raises:
-
class
azure.mgmt.monitor.operations.
MetricAlertsStatusOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MetricAlertsStatusOperations 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 – Client Api Version. Constant value: “2018-03-01”.
-
list
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve an alert rule status.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: MetricAlertStatusCollection or ClientRawResponse if raw=true
Return type: MetricAlertStatusCollection or ClientRawResponse
Raises:
-
list_by_name
(resource_group_name, rule_name, status_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve an alert rule status.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- status_name (str) – The name of the status.
- 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: MetricAlertStatusCollection or ClientRawResponse if raw=true
Return type: MetricAlertStatusCollection or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
class
azure.mgmt.monitor.operations.
ScheduledQueryRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ScheduledQueryRulesOperations 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 – Client Api Version. Constant value: “2018-04-16”.
-
create_or_update
(resource_group_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates an log search rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- parameters (LogSearchRuleResource) – The parameters of the rule to create or update.
- 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: LogSearchRuleResource or ClientRawResponse if raw=true
Return type: LogSearchRuleResource or ClientRawResponse
Raises:
-
delete
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a Log Search rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an Log Search rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- 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: LogSearchRuleResource or ClientRawResponse if raw=true
Return type: LogSearchRuleResource or ClientRawResponse
Raises:
-
list_by_resource_group
(resource_group_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ List the Log Search rules within a resource group.
Parameters: - resource_group_name (str) – The name of the resource group.
- filter (str) – The filter to apply on the operation. For more information please see https://msdn.microsoft.com/en-us/library/azure/dn931934.aspx
- 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: An iterator like instance of LogSearchRuleResource
Return type: Raises:
-
list_by_subscription
(filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ List the Log Search rules within a subscription group.
Parameters: - filter (str) – The filter to apply on the operation. For more information please see https://msdn.microsoft.com/en-us/library/azure/dn931934.aspx
- 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: An iterator like instance of LogSearchRuleResource
Return type: Raises:
-
models
= <module 'azure.mgmt.monitor.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/monitor/models/__init__.py'>¶
-
update
(resource_group_name, rule_name, tags=None, enabled=None, custom_headers=None, raw=False, **operation_config)[source]¶ Update log search Rule.
Parameters: - resource_group_name (str) – The name of the resource group.
- rule_name (str) – The name of the rule.
- tags (dict[str, str]) – Resource tags
- enabled (str or Enabled) – The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Possible values include: ‘true’, ‘false’
- 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: LogSearchRuleResource or ClientRawResponse if raw=true
Return type: LogSearchRuleResource or ClientRawResponse
Raises: