azure_rm_monitormetricalerts

Create, update and delete metric alerts

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_monitormetricalerts

Synopsis

Create, update and delete metric alerts

Parameters

Name	Type	Required	Default	Description
actions	list			The actions that will activate when the condition is met.
U(https://learn.microsoft.com/en-us/rest/api/monitor/metric-alerts/create-or-update?view=rest-monitor-2018-03-01&tabs=HTTP#metricalertaction)
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	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.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The C(msi) was added in Ansible 2.6.
auto_mitigate	bool			the flag that indicates whether the alert should be auto resolved or not. The default is true.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
criteria	dict			Defines the specific alert criteria information.
Required for creation.
description	string			A description of this metric alert rule.
disable_instance_discovery	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
enabled	bool			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.
evaluation_frequency	string			How often the metric alert is evaluated represented in ISO 8601 duration format.
U(https://en.wikipedia.org/wiki/ISO_8601#Durations)
Required for creation.
location	string			Location of the metric alert.
Metric alerts are usually ‘Global’.
If unspecified will default to ‘Global’ on creation.
log_mode	string			Parent argument.
log_path	string			Parent argument.
name	string	yes		The name of the metric alert you’re creating, updateing or deleting.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
password	string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile	string			Security profile found in ~/.azure/credentials file.
resource_group	string	yes		The name of the resource group.
scopes	list			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.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
severity	int			Severity 1-4 of the alert.
Required on creation.
state	string		`present`	State of the metric alert
Use C(present) for creating/updating a metric alert.
Use C(absent) for deleting a metric alert.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
target_resource_region	string			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.
target_resource_type	string			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.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
window_size	string			The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
U(https://en.wikipedia.org/wiki/ISO_8601#Durations)
Required for creation.
x509_certificate_path	string			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.

Example

yaml

- name: Add a metric alert
  azure.azcollection.azure_rm_monitormetricalerts:
    state: present
    resource_group: myrg
    location: Global
    name: metric_alert_name
    actions:
      - action_group_id: subscriptions/<sub-id>/resourceGroups/myrg/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/<sub-id>/resourceGroups/myrg/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: myrg
    append_tags: true
    tags:
      ThisIsAnAddedExampleTag: ExampleValue

- name: Delete a metric alert
  azure.azcollection.azure_rm_monitormetricalerts:
    state: absent
    name: metric_alert_name
    resource_group: myrg