Puppet Task: alertsmanagement_azure_alerts_get_all
- Defined in:
-
tasks/alertsmanagement_azure_alerts_get_all.json,
tasks/alertsmanagement_azure_alerts_get_all.rb
Overview
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.
Supports noop? false
Parameters
- page_count (Optional[String[1]]) — 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 (Optional[String[1]]) — Sort the query results by input field, Default value is 'lastModifiedDateTime'.
- select (Optional[String[1]]) — 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.
- target_resource_type (Optional[String[1]]) — Filter by target resource type. Default value is select all.
- target_resource_group (Optional[String[1]]) — Filter by target resource group name. Default value is select all.
- alert_rule (Optional[String[1]]) — Filter by specific alert rule. Default value is to select all.
- smart_group_id (Optional[String[1]]) — Filter the alerts list by the Smart Group Id. Default value is none.
- include_egress_config (Optional[String[1]]) — Include egress config which would be used for displaying the content in portal. Default value is 'false'.
- monitor_service (Optional[String[1]]) — Filter by monitor service which generates the alert instance. Default value is select all.
- monitor_condition (Optional[String[1]]) — Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
- include_context (Optional[String[1]]) — Include context which has contextual data specific to the monitor service. Default value is false'
- custom_time_range (Optional[String[1]]) — Filter by custom time range in the format / 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.
- scope (Optional[String[1]]) — scope here is resourceId for which alert is created.
- target_resource (Optional[String[1]]) — Filter by target resource( which is full ARM ID) Default value is select all.
- alert_state (Optional[String[1]]) — Filter by state of the alert instance. Default value is to select all.
- error (Optional[String[1]]) —
- severity (Optional[String[1]]) — Filter by severity. Default value is select all.
- sort_order (Optional[String[1]]) — Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.
- time_range (Optional[String[1]]) — Filter by time range by below listed values. Default value is 1 day.
- api_version (Optional[String[1]]) — API version.