azure.azcollection.azure_rm_monitormetricalerts module – Create, update and delete metric alerts.

actions

list / elements=dictionary

The actions that will activate when the condition is met.

https://learn.microsoft.com/en-us/rest/api/monitor/metric-alerts/create-or-update?view=rest-monitor-2018-03-01&tabs=HTTP#metricalertaction

action_group_id

string

The resource ID of the Action Group.

Must be set when setting an action group.

webhook_properties

dictionary

The dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

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:

• false
• true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables.

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

auto_mitigate

boolean

the flag that indicates whether the alert should be auto resolved or not. The default is true.

Choices:

• false
• true

cert_validation_mode

string

added in azure.azcollection 0.0.1

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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

• "ignore"
• "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

criteria

dictionary

Defines the specific alert criteria information.

Required for creation.

extra_keys

dictionary

https://learn.microsoft.com/en-us/rest/api/monitor/metric-alerts/create-or-update?view=rest-monitor-2018-03-01&tabs=HTTP#request-body

extra keys depends on the odata_type

odata_type

string

Specifies the type of the alert criteria.

Required on creation.

Choices:

• "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
• "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
• "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"

description

string

A description of this metric alert rule.

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

• false ← (default)
• true

enabled

boolean

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:

• false
• true

evaluation_frequency

string

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

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 / required

The name of the metric alert you’re creating, updateing or deleting.

oidc_token

string

added in azure.azcollection 3.17.0

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 AZURE_FEDERATED_TOKEN environment variable.

oidc_token_file_path

path

added in azure.azcollection 3.17.0

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 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 / required

The name of the resource group.

scopes

list / elements=string

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

integer

Severity 1-4 of the alert.

Required on creation.

state

string

State of the metric alert

Use present for creating/updating a metric alert.

Use absent for deleting a metric alert.

Choices:

• "present" ← (default)
• "absent"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

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

added in azure.azcollection 1.14.0

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.

window_size

string

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.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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.

metricalert

dictionary

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: {"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", "id": "subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.Insights/metricAlerts/metric_alert_name", "location": "Global", "name": "metric_alert_name", "scopes": ["/subscriptions/<sub-id>/resourceGroups/myrg/providers/Microsoft.RecoveryServices/vaults/recovery_vault_name"], "severity": 3, "tags": {"TestTag1": "TestValue1"}, "target_resource_type": "Microsoft.RecoveryServices/vaults", "type": "Microsoft.Insights/metricAlerts", "window_size": "P1D"}