azure.azcollection.azure_rm_monitoractiongroups module – Create, update and delete Action Groups.
Note
This module is part of the azure.azcollection collection (version 3.7.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_monitoractiongroups.
New in azure.azcollection 3.7.0
Synopsis
Create, update and delete Action Groups.
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 |
|---|---|
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:
|
|
The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The arm role id. Required when setting this receiver. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). 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 list of AutomationRunbook receivers that are part of this action group. |
|
The Azure automation account Id which holds this runbook and authenticate to Azure resource. Required when setting this receiver. |
|
Indicates whether this instance is global runbook. Choices:
|
|
Indicates name of the webhook. |
|
The name for this runbook. Required when setting this receiver. |
|
The URI where webhooks should be sent. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). Choices:
|
|
The resource id for webhook linked to this runbook. Required when setting this receiver. |
|
The list of AzureAppPush receivers that are part of this action group. |
|
The email address registered for the Azure mobile app. Required when setting this receiver. |
|
The name of this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The list of azure function receivers that are part of this action group. |
|
The azure resource id of the function app. Required when setting this receiver. |
|
The function name in the function app. Required when setting this receiver. |
|
The http trigger url where http request sent to. Required when setting this receiver. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). 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: |
|
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:
|
|
The list of email receivers that are part of this action group. |
|
The email address of this receiver. Required when setting this receiver. |
|
The name of this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). Choices:
|
|
Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Choices:
|
|
The list of event hub receivers that are part of this action group. |
|
The name of the specific Event Hub queue. Required when setting this receiver. |
|
The Event Hub namespace. Required when setting this receiver. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The Id for the subscription containing this event hub. Required when setting this receiver. |
|
The tenant Id for the subscription containing this event hub. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). Choices:
|
|
The short name of the action group. This will be used in SMS messages. |
|
The list of webhook receivers that are part of this action group. |
|
Unique identification of ITSM connection among multiple defined in above workspace. Required when setting this receiver. |
|
The name of this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
Region in which workspace resides. Required when setting this receiver. |
|
JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. Required when setting this receiver. |
|
OMS LA instance identifier. Required when setting this receiver. |
|
Location of the action group. defaults to location of exiting action group or location of the resource group if unspecified. Action groups are usually ‘Global’. |
|
Parent argument. |
|
Parent argument. |
|
The list of logic app receivers that are part of this action group. |
|
The callback url where http request sent to. Required when setting this receiver. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The azure resource id of the logic app receiver. Required when setting this receiver. |
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). Choices:
|
|
The name of the action group you’re creating/changing. |
|
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. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
The list of SMS receivers that are part of this action group. |
|
The country code of the SMS receiver. Required when setting this receiver. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The phone number of the SMS receiver. Required when setting this receiver. |
|
State of the action group. 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. |
|
The list of voice receivers that are part of this action group. |
|
The country code of the voice receiver. Required when setting this receiver. |
|
The name this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
The phone number of the voice receiver. Required when setting this receiver. |
|
The list of webhook receivers that are part of this action group. |
|
Indicates the identifier uri for aad auth. |
|
The name of this receiver. Names must be unique across all receivers within an action group. Required when setting this receiver. |
|
Indicates the webhook app object Id for aad auth. |
|
The URI where webhooks should be sent. Required when setting this receiver. |
|
Indicates the tenant id for aad auth. |
|
Indicates whether or not use AAD authentication. Defaults to False when not set (server side default). Choices:
|
|
Indicates whether to use common alert schema. Defaults to False when not set (server side default). Choices:
|
|
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 action group
azure.azcollection.azure_rm_monitoractiongroups:
state: present
name: action_group_name
resource_group: resource_group_name
enabled: true
location: Global
email_receivers:
- email_address: [email protected]
name: sendmail
use_common_alert_schema: true
group_short_name: short_name
append_tags: false
tags:
ThisIsAnExampleTag: ExampleValue
- name: Add tag to existing action group
azure.azcollection.azure_rm_monitoractiongroups:
state: present
name: action_group_name
resource_group: resource_group_name
append_tags: true
tags:
ThisIsAnAddedExampleTag: ExampleValue
- name: Remove all tags on existing action group
azure.azcollection.azure_rm_monitoractiongroups:
state: present
name: action_group_name
resource_group: resource_group_name
append_tags: false
- name: Delete a action group
azure.azcollection.azure_rm_monitoractiongroups:
state: absent
name: action_group_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 action group Is null on state==absent (action group does not exist or will be deleted) Assumes you make legal changes in check mode Returned: always Sample: |