azure.azcollection.azure_rm_monitormetricalerts module – Create, update and delete metric alerts.
Note
This module is part of the azure.azcollection collection (version 3.9.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_monitormetricalerts.
New in azure.azcollection 3.7.0
Synopsis
Create, update and delete metric alerts.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
The actions that will activate when the condition is met. |
|
The resource ID of the Action Group. Must be set when setting an action group. |
|
The dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. |
|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object’s metadata. Choices:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
the flag that indicates whether the alert should be auto resolved or not. The default is true. Choices:
|
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Defines the specific alert criteria information. Required for creation. |
|
extra keys depends on the odata_type |
|
Specifies the type of the alert criteria. Required on creation. Choices:
|
|
A description of this metric alert rule. |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
Indicates whether this metric alert is enabled. If an metric alert is not enabled, then none of its receivers will receive communications. Required on creation. Choices:
|
|
How often the metric alert is evaluated represented in ISO 8601 duration format. https://en.wikipedia.org/wiki/ISO_8601#Durations Required for creation. |
|
Location of the metric alert. Metric alerts are usually ‘Global’. If unspecified will default to ‘Global’ on creation. |
|
Parent argument. |
|
Parent argument. |
|
The name of the metric alert you’re creating, updateing or deleting. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group. |
|
A list of resource IDs that will be used as prefixes. The alert will only apply to Metric events with resource IDs that fall under one of these prefixes. This list must include at least one item for creation. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Severity 1-4 of the alert. Required on creation. |
|
State of the metric alert Use Use Choices:
|
|
Your Azure subscription Id. |
|
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag. Azure Front Door doesn’t support the use of Azure Automation and Azure CDN only support 15 tags on resources. |
|
The region of the target resource(s) on which the alert is created/updated. Mandatory (for creation) if the scope contains a subscription, resource group, or more than one resource. |
|
The resource type of the target resource(s) on which the alert is created/updated. Mandatory (for creation) if the scope contains a subscription, resource group, or more than one resource. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. https://en.wikipedia.org/wiki/ISO_8601#Durations Required for creation. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- name: Add a metric alert
azure.azcollection.azure_rm_monitormetricalerts:
state: present
resource_group: resource_group_name
location: Global
name: metric_alert_name
actions:
- action_group_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/microsoft.insights/actionGroups/action_group_name
auto_mitigate: true
criteria:
all_of:
- criterion_type: StaticThresholdCriterion
dimensions:
- name: dataSourceURL
operator: Include
values:
- '*'
- name: healthStatus
operator: Exclude
values:
- Healthy
metric_name: BackupHealthEvent
metric_namespace: Microsoft.RecoveryServices/vaults
name: Metric1
operator: GreaterThan
skip_metric_validation: false
threshold: 0.0
time_aggregation: Count
odata_type: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria
description: Alert on Backup Health Events
enabled: true
evaluation_frequency: PT1H
scopes:
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/Microsoft.RecoveryServices/vaults/recovery_vault_name
severity: 3
tags:
TestTag1: TestValue1
target_resource_type: Microsoft.RecoveryServices/vaults
window_size: P1D
- name: Add tag to existing metric alert
azure.azcollection.azure_rm_monitormetricalerts:
state: present
name: metric_alert_name
resource_group: resource_group_name
append_tags: true
tags:
ThisIsAnAddedExampleTag: ExampleValue
- name: Delete a metric alert
azure.azcollection.azure_rm_monitormetricalerts:
state: absent
name: metric_alert_name
resource_group: resource_group_name
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the metric alert Is null on state==absent (metric alert does not exist or will be deleted) Assumes you make legal changes in check mode Returned: always Sample: |