azure.azcollection.azure_rm_monitoractivitylogalerts module – Create, update and delete Activity Log Alerts.
Note
This module is part of the azure.azcollection collection (version 3.8.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_monitoractivitylogalerts.
New in azure.azcollection 3.7.0
Synopsis
Create, update and delete Activity Log 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:
|
|
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: |
|
The condition that will cause this alert to activate. |
|
The list of Activity Log Alert rule conditions. |
|
An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. |
|
The value of the event’s field will be compared to the values in this array (case-insensitive) to determine if the condition is met. |
|
The value of the event’s field will be compared to this value (case-insensitive) to determine if the condition is met. |
|
The name of the Activity Log events field that this condition will examine. The possible values for this field are (case-insensitive) resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType, or anything beginning with properties. |
|
The value of the events field will be compared to the values in this array (case-insensitive) to determine if the condition is met. |
|
The value of the events field will be compared to this value (case-insensitive) to determine if the condition is met. |
|
The name of the Activity Log event’s field that this condition will examine. The possible values for this field are (case-insensitive) resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType or anything beginning with properties. |
|
A description of this Activity Log 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 activity log alert is enabled. If an activity log alert is not enabled, then none of its receivers will receive communications. Server side default false – should be true. https://github.com/Azure/azure-rest-api-specs/issues/35343 Choices:
|
|
Location of the activity log alert. Should be optional, but is not optional on creation. https://github.com/Azure/azure-rest-api-specs/issues/35342 Activity log alerts are usually ‘Global’. On creation module will default to ‘Global’ if unspecified. |
|
Parent argument. |
|
Parent argument. |
|
The name of the activity log alert you’re creating, updating 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 Activity Log 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. |
|
State of the activity log 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. |
|
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. |
|
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 activity log alert
azure.azcollection.azure_rm_monitoractivitylogalerts:
state: present
resource_group: resource_group_name
location: global
name: activity_log_alert_resource_health_example
scopes:
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name
condition:
all_of:
- equals: ResourceHealth
field: category
- any_of:
- equals: Unknown
field: properties.currentHealthStatus
- equals: Unavailable
field: properties.currentHealthStatus
- equals: Degraded
field: properties.currentHealthStatus
- any_of:
- equals: Unknown
field: properties.previousHealthStatus
- equals: Unavailable
field: properties.previousHealthStatus
- equals: Degraded
field: properties.previousHealthStatus
- equals: Available
field: properties.previousHealthStatus
- any_of:
- equals: PlatformInitiated
field: properties.cause
actions:
action_groups:
- action_group_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource_group_name/providers/microsoft.insights/actionGroups/action_group_name
- name: Add tag to existing activity log alert
azure.azcollection.azure_rm_monitoractivitylogalerts:
state: present
name: activity_log_alert_name
resource_group: resource_group_name
append_tags: true
tags:
ThisIsAnAddedExampleTag: ExampleValue
- name: Delete a activity log alert
azure.azcollection.azure_rm_monitoractivitylogalerts:
state: absent
name: activity_log_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 activity log alert Is null on state==absent (activity log alert does not exist or will be deleted) Assumes you make legal changes in check mode Returned: always Sample: |