azure.mgmt.alertsmanagement.operations module

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

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2019-05-05-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]

List all operations available through Azure Alerts Management Resource Provider.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.alertsmanagement.models' from '/builddir/build/BUILD/azure-sdk-for-python-2b2cfd46758e7b9d55346f79f05592d7488c1bd0/sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/models/__init__.py'>
class azure.mgmt.alertsmanagement.operations.AlertsOperations(client, config, serializer, deserializer)[source]

Bases: object

AlertsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2019-05-05-preview”.

  • identifier – Identification of the information to be retrieved by API call. Constant value: “MonitorServiceList”.

change_state(alert_id, new_state, custom_headers=None, raw=False, **operation_config)[source]

Change the state of an alert.

Parameters
  • alert_id (str) – Unique ID of an alert instance.

  • new_state (str or AlertState) – New state of the alert. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Alert or ClientRawResponse if raw=true

Return type

Alert or ClientRawResponse

Raises

ErrorResponseException

get_all(target_resource=None, target_resource_type=None, target_resource_group=None, monitor_service=None, monitor_condition=None, severity=None, alert_state=None, alert_rule=None, smart_group_id=None, include_context=None, include_egress_config=None, page_count=None, sort_by=None, sort_order=None, select=None, time_range=None, custom_time_range=None, custom_headers=None, raw=False, **operation_config)[source]

List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime. .

Parameters
  • target_resource (str) – Filter by target resource( which is full ARM ID) Default value is select all.

  • target_resource_type (str) – Filter by target resource type. Default value is select all.

  • target_resource_group (str) – Filter by target resource group name. Default value is select all.

  • monitor_service (str or MonitorService) – Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’

  • monitor_condition (str or MonitorCondition) – Filter by monitor condition which is either ‘Fired’ or ‘Resolved’. Default value is to select all. Possible values include: ‘Fired’, ‘Resolved’

  • severity (str or Severity) – Filter by severity. Default value is select all. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

  • alert_state (str or AlertState) – Filter by state of the alert instance. Default value is to select all. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

  • alert_rule (str) – Filter by specific alert rule. Default value is to select all.

  • smart_group_id (str) – Filter the alerts list by the Smart Group Id. Default value is none.

  • include_context (bool) – Include context which has contextual data specific to the monitor service. Default value is false’

  • include_egress_config (bool) – Include egress config which would be used for displaying the content in portal. Default value is ‘false’.

  • page_count (int) – Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the “includeContent” filter is selected, maximum value allowed is 25. Default value is 25.

  • sort_by (str or AlertsSortByFields) – Sort the query results by input field, Default value is ‘lastModifiedDateTime’. Possible values include: ‘name’, ‘severity’, ‘alertState’, ‘monitorCondition’, ‘targetResource’, ‘targetResourceName’, ‘targetResourceGroup’, ‘targetResourceType’, ‘startDateTime’, ‘lastModifiedDateTime’

  • sort_order (str) – Sort the query results order in either ascending or descending. Default value is ‘desc’ for time fields and ‘asc’ for others. Possible values include: ‘asc’, ‘desc’

  • select (str) – This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section.

  • time_range (str or TimeRange) – Filter by time range by below listed values. Default value is 1 day. Possible values include: ‘1h’, ‘1d’, ‘7d’, ‘30d’

  • custom_time_range (str) – Filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)’. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Alert

Return type

AlertPaged[Alert]

Raises

ErrorResponseException

get_by_id(alert_id, custom_headers=None, raw=False, **operation_config)[source]

Get a specific alert.

Get information related to a specific alert.

Parameters
  • alert_id (str) – Unique ID of an alert instance.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Alert or ClientRawResponse if raw=true

Return type

Alert or ClientRawResponse

Raises

ErrorResponseException

get_history(alert_id, custom_headers=None, raw=False, **operation_config)[source]

Get the history of an alert, which captures any monitor condition changes (Fired/Resolved) and alert state changes (New/Acknowledged/Closed).

Parameters
  • alert_id (str) – Unique ID of an alert instance.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

AlertModification or ClientRawResponse if raw=true

Return type

AlertModification or ClientRawResponse

Raises

ErrorResponseException

get_summary(groupby, include_smart_groups_count=None, target_resource=None, target_resource_type=None, target_resource_group=None, monitor_service=None, monitor_condition=None, severity=None, alert_state=None, alert_rule=None, time_range=None, custom_time_range=None, custom_headers=None, raw=False, **operation_config)[source]

Get a summarized count of your alerts grouped by various parameters (e.g. grouping by ‘Severity’ returns the count of alerts for each severity).

Parameters
  • groupby (str or AlertsSummaryGroupByFields) – This parameter allows the result set to be grouped by input fields (Maximum 2 comma separated fields supported). For example, groupby=severity or groupby=severity,alertstate. Possible values include: ‘severity’, ‘alertState’, ‘monitorCondition’, ‘monitorService’, ‘signalType’, ‘alertRule’

  • include_smart_groups_count (bool) – Include count of the SmartGroups as part of the summary. Default value is ‘false’.

  • target_resource (str) – Filter by target resource( which is full ARM ID) Default value is select all.

  • target_resource_type (str) – Filter by target resource type. Default value is select all.

  • target_resource_group (str) – Filter by target resource group name. Default value is select all.

  • monitor_service (str or MonitorService) – Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’

  • monitor_condition (str or MonitorCondition) – Filter by monitor condition which is either ‘Fired’ or ‘Resolved’. Default value is to select all. Possible values include: ‘Fired’, ‘Resolved’

  • severity (str or Severity) – Filter by severity. Default value is select all. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

  • alert_state (str or AlertState) – Filter by state of the alert instance. Default value is to select all. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

  • alert_rule (str) – Filter by specific alert rule. Default value is to select all.

  • time_range (str or TimeRange) – Filter by time range by below listed values. Default value is 1 day. Possible values include: ‘1h’, ‘1d’, ‘7d’, ‘30d’

  • custom_time_range (str) – Filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)’. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

AlertsSummary or ClientRawResponse if raw=true

Return type

AlertsSummary or ClientRawResponse

Raises

ErrorResponseException

meta_data(custom_headers=None, raw=False, **operation_config)[source]

List alerts meta data information based on value of identifier parameter.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

AlertsMetaData or ClientRawResponse if raw=true

Return type

AlertsMetaData or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.alertsmanagement.models' from '/builddir/build/BUILD/azure-sdk-for-python-2b2cfd46758e7b9d55346f79f05592d7488c1bd0/sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/models/__init__.py'>
class azure.mgmt.alertsmanagement.operations.SmartGroupsOperations(client, config, serializer, deserializer)[source]

Bases: object

SmartGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2019-05-05-preview”.

change_state(smart_group_id, new_state, custom_headers=None, raw=False, **operation_config)[source]

Change the state of a Smart Group.

Parameters
  • smart_group_id (str) – Smart group unique id.

  • new_state (str or AlertState) – New state of the alert. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SmartGroup or ClientRawResponse if raw=true

Return type

SmartGroup or ClientRawResponse

Raises

ErrorResponseException

get_all(target_resource=None, target_resource_group=None, target_resource_type=None, monitor_service=None, monitor_condition=None, severity=None, smart_group_state=None, time_range=None, page_count=None, sort_by=None, sort_order=None, custom_headers=None, raw=False, **operation_config)[source]

Get all Smart Groups within a specified subscription.

List all the Smart Groups within a specified subscription. .

Parameters
  • target_resource (str) – Filter by target resource( which is full ARM ID) Default value is select all.

  • target_resource_group (str) – Filter by target resource group name. Default value is select all.

  • target_resource_type (str) – Filter by target resource type. Default value is select all.

  • monitor_service (str or MonitorService) – Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’

  • monitor_condition (str or MonitorCondition) – Filter by monitor condition which is either ‘Fired’ or ‘Resolved’. Default value is to select all. Possible values include: ‘Fired’, ‘Resolved’

  • severity (str or Severity) – Filter by severity. Default value is select all. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

  • smart_group_state (str or AlertState) – Filter by state of the smart group. Default value is to select all. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

  • time_range (str or TimeRange) – Filter by time range by below listed values. Default value is 1 day. Possible values include: ‘1h’, ‘1d’, ‘7d’, ‘30d’

  • page_count (int) – Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the “includeContent” filter is selected, maximum value allowed is 25. Default value is 25.

  • sort_by (str or SmartGroupsSortByFields) – Sort the query results by input field. Default value is sort by ‘lastModifiedDateTime’. Possible values include: ‘alertsCount’, ‘state’, ‘severity’, ‘startDateTime’, ‘lastModifiedDateTime’

  • sort_order (str) – Sort the query results order in either ascending or descending. Default value is ‘desc’ for time fields and ‘asc’ for others. Possible values include: ‘asc’, ‘desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of SmartGroup

Return type

SmartGroupPaged[SmartGroup]

Raises

ErrorResponseException

get_by_id(smart_group_id, custom_headers=None, raw=False, **operation_config)[source]

Get information related to a specific Smart Group.

Get information related to a specific Smart Group.

Parameters
  • smart_group_id (str) – Smart group unique id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SmartGroup or ClientRawResponse if raw=true

Return type

SmartGroup or ClientRawResponse

Raises

ErrorResponseException

get_history(smart_group_id, custom_headers=None, raw=False, **operation_config)[source]

Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .

Parameters
  • smart_group_id (str) – Smart group unique id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SmartGroupModification or ClientRawResponse if raw=true

Return type

SmartGroupModification or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.alertsmanagement.models' from '/builddir/build/BUILD/azure-sdk-for-python-2b2cfd46758e7b9d55346f79f05592d7488c1bd0/sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/models/__init__.py'>
class azure.mgmt.alertsmanagement.operations.ActionRulesOperations(client, config, serializer, deserializer)[source]

Bases: object

ActionRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2019-05-05-preview”.

create_update(resource_group_name, action_rule_name, action_rule, custom_headers=None, raw=False, **operation_config)[source]

Create/update an action rule.

Creates/Updates a specific action rule.

Parameters
  • resource_group_name (str) – Resource group name where the resource is created.

  • action_rule_name (str) – The name of action rule that needs to be created/updated

  • action_rule (ActionRule) – action rule to be created/updated

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ActionRule or ClientRawResponse if raw=true

Return type

ActionRule or ClientRawResponse

Raises

ErrorResponseException

delete(resource_group_name, action_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Delete action rule.

Deletes a given action rule.

Parameters
  • resource_group_name (str) – Resource group name where the resource is created.

  • action_rule_name (str) – The name that needs to be deleted

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

bool or ClientRawResponse if raw=true

Return type

bool or ClientRawResponse

Raises

ErrorResponseException

get_by_name(resource_group_name, action_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Get action rule by name.

Get a specific action rule.

Parameters
  • resource_group_name (str) – Resource group name where the resource is created.

  • action_rule_name (str) – The name of action rule that needs to be fetched

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ActionRule or ClientRawResponse if raw=true

Return type

ActionRule or ClientRawResponse

Raises

ErrorResponseException

list_by_resource_group(resource_group_name, target_resource_group=None, target_resource_type=None, target_resource=None, severity=None, monitor_service=None, impacted_scope=None, description=None, alert_rule_id=None, action_group=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Get all action rules created in a resource group.

List all action rules of the subscription, created in given resource group and given input filters.

Parameters
  • resource_group_name (str) – Resource group name where the resource is created.

  • target_resource_group (str) – Filter by target resource group name. Default value is select all.

  • target_resource_type (str) – Filter by target resource type. Default value is select all.

  • target_resource (str) – Filter by target resource( which is full ARM ID) Default value is select all.

  • severity (str or Severity) – Filter by severity. Default value is select all. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

  • monitor_service (str or MonitorService) – Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’

  • impacted_scope (str) – filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope.

  • description (str) – filter by alert rule description

  • alert_rule_id (str) – filter by alert rule id

  • action_group (str) – filter by action group configured as part of action rule

  • name (str) – filter by action rule name

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ActionRule

Return type

ActionRulePaged[ActionRule]

Raises

ErrorResponseException

list_by_subscription(target_resource_group=None, target_resource_type=None, target_resource=None, severity=None, monitor_service=None, impacted_scope=None, description=None, alert_rule_id=None, action_group=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Get all action rule in a given subscription.

List all action rules of the subscription and given input filters.

Parameters
  • target_resource_group (str) – Filter by target resource group name. Default value is select all.

  • target_resource_type (str) – Filter by target resource type. Default value is select all.

  • target_resource (str) – Filter by target resource( which is full ARM ID) Default value is select all.

  • severity (str or Severity) – Filter by severity. Default value is select all. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

  • monitor_service (str or MonitorService) – Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’

  • impacted_scope (str) – filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope.

  • description (str) – filter by alert rule description

  • alert_rule_id (str) – filter by alert rule id

  • action_group (str) – filter by action group configured as part of action rule

  • name (str) – filter by action rule name

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ActionRule

Return type

ActionRulePaged[ActionRule]

Raises

ErrorResponseException

update(resource_group_name, action_rule_name, status=None, tags=None, custom_headers=None, raw=False, **operation_config)[source]

Patch action rule.

Update enabled flag and/or tags for the given action rule.

Parameters
  • resource_group_name (str) – Resource group name where the resource is created.

  • action_rule_name (str) – The name that needs to be updated

  • status (str or ActionRuleStatus) – Indicates if the given action rule is enabled or disabled. Possible values include: ‘Enabled’, ‘Disabled’

  • tags (object) – tags to be updated

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ActionRule or ClientRawResponse if raw=true

Return type

ActionRule or ClientRawResponse

Raises

ErrorResponseException

models = <module 'azure.mgmt.alertsmanagement.models' from '/builddir/build/BUILD/azure-sdk-for-python-2b2cfd46758e7b9d55346f79f05592d7488c1bd0/sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/models/__init__.py'>
class azure.mgmt.alertsmanagement.operations.SmartDetectorAlertRulesOperations(client, config, serializer, deserializer)[source]

Bases: object

SmartDetectorAlertRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2019-06-01”.

create_or_update(resource_group_name, alert_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Smart Detector alert rule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • alert_rule_name (str) – The name of the alert rule.

  • parameters (AlertRule) – 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_configOperation configuration overrides.

Returns

AlertRule or ClientRawResponse if raw=true

Return type

AlertRule or ClientRawResponse

Raises

ErrorResponse1Exception

delete(resource_group_name, alert_rule_name, custom_headers=None, raw=False, **operation_config)[source]

Delete an existing Smart Detector alert rule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • alert_rule_name (str) – The name of the alert rule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponse1Exception

get(resource_group_name, alert_rule_name, expand_detector=None, custom_headers=None, raw=False, **operation_config)[source]

Get a specific Smart Detector alert rule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • alert_rule_name (str) – The name of the alert rule.

  • expand_detector (bool) – Indicates if Smart Detector should be expanded.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

AlertRule or ClientRawResponse if raw=true

Return type

AlertRule or ClientRawResponse

Raises

ErrorResponse1Exception

list(expand_detector=None, custom_headers=None, raw=False, **operation_config)[source]

List all the existing Smart Detector alert rules within the subscription.

Parameters
  • expand_detector (bool) – Indicates if Smart Detector should be expanded.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of AlertRule

Return type

AlertRulePaged[AlertRule]

Raises

ErrorResponse1Exception

list_by_resource_group(resource_group_name, expand_detector=None, custom_headers=None, raw=False, **operation_config)[source]

List all the existing Smart Detector alert rules within the subscription and resource group.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • expand_detector (bool) – Indicates if Smart Detector should be expanded.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of AlertRule

Return type

AlertRulePaged[AlertRule]

Raises

ErrorResponse1Exception

patch(resource_group_name, alert_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Patch a specific Smart Detector alert rule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • alert_rule_name (str) – The name of the alert rule.

  • parameters (AlertRulePatchObject) – 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_configOperation configuration overrides.

Returns

AlertRule or ClientRawResponse if raw=true

Return type

AlertRule or ClientRawResponse

Raises

ErrorResponse1Exception

models = <module 'azure.mgmt.alertsmanagement.models' from '/builddir/build/BUILD/azure-sdk-for-python-2b2cfd46758e7b9d55346f79f05592d7488c1bd0/sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/models/__init__.py'>