azure.azcollection.azure_rm_monitoractiongroups module – Create, update and delete Action Groups.

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)

arm_role_receivers

list / elements=dictionary

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.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.armrolereceiver?view=azure-python

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

role_id

string

The arm role id.

Required when setting this receiver.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

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"

automation_runbook_receivers

list / elements=dictionary

The list of AutomationRunbook receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.automationrunbookreceiver?view=azure-python

automation_account_id

string

The Azure automation account Id which holds this runbook and authenticate to Azure resource.

Required when setting this receiver.

is_global_runbook

boolean

Indicates whether this instance is global runbook.

Choices:

• false
• true

name

string

Indicates name of the webhook.

runbook_name

string

The name for this runbook.

Required when setting this receiver.

service_uri

string

The URI where webhooks should be sent.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

webhook_resource_id

string

The resource id for webhook linked to this runbook.

Required when setting this receiver.

azure_app_push_receivers

list / elements=dictionary

The list of AzureAppPush receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.azureapppushreceiver?view=azure-python

email_address

string

The email address registered for the Azure mobile app.

Required when setting this receiver.

name

string

The name of this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

azure_function_receivers

list / elements=dictionary

The list of azure function receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.azurefunctionreceiver?view=azure-python

function_app_resource_id

string

The azure resource id of the function app.

Required when setting this receiver.

function_name

string

The function name in the function app.

Required when setting this receiver.

http_trigger_url

string

The http trigger url where http request sent to.

Required when setting this receiver.

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

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"

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

email_receivers

list / elements=dictionary

The list of email receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.emailreceiver?view=azure-python

email_address

string

The email address of this receiver.

Required when setting this receiver.

name

string

The name of this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

enabled

boolean

Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.

Choices:

• false
• true

event_hub_receivers

list / elements=dictionary

The list of event hub receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.eventhubreceiver?view=azure-python

event_hub_name

string

The name of the specific Event Hub queue.

Required when setting this receiver.

event_hub_name_space

string

The Event Hub namespace.

Required when setting this receiver.

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

subscription_id

string

The Id for the subscription containing this event hub.

Required when setting this receiver.

tenant_id

string

The tenant Id for the subscription containing this event hub.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

group_short_name

string

The short name of the action group. This will be used in SMS messages.

itsm_receivers

list / elements=dictionary

The list of webhook receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.itsmreceiver?view=azure-python

connection_id

string

Unique identification of ITSM connection among multiple defined in above workspace.

Required when setting this receiver.

name

string

The name of this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

region

string

Region in which workspace resides.

Required when setting this receiver.

ticket_configuration

string

JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

Required when setting this receiver.

workspace_id

string

OMS LA instance identifier.

Required when setting this receiver.

location

string

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’.

log_mode

string

Parent argument.

log_path

string

Parent argument.

logic_app_receivers

list / elements=dictionary

The list of logic app receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.logicappreceiver?view=azure-python

callback_url

string

The callback url where http request sent to.

Required when setting this receiver.

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

resource_id

string

The azure resource id of the logic app receiver.

Required when setting this receiver.

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

name

string / required

The name of the action group you’re creating/changing.

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.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

sms_receivers

list / elements=dictionary

The list of SMS receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.smsreceiver?view=azure-python

country_code

string

The country code of the SMS receiver.

Required when setting this receiver.

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

phone_number

string

The phone number of the SMS receiver.

Required when setting this receiver.

state

string

State of the action group.

Use present for creating/updating a action group.

Use absent for deleting a action group.

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.

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.

voice_receivers

list / elements=dictionary

The list of voice receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.voicereceiver?view=azure-python

country_code

string

The country code of the voice receiver.

Required when setting this receiver.

name

string

The name this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

phone_number

string

The phone number of the voice receiver.

Required when setting this receiver.

webhook_receivers

list / elements=dictionary

The list of webhook receivers that are part of this action group.

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.v2023_01_01.models.webhookreceiver?view=azure-python

identifier_uri

string

Indicates the identifier uri for aad auth.

name

string

The name of this receiver. Names must be unique across all receivers within an action group.

Required when setting this receiver.

object_id

string

Indicates the webhook app object Id for aad auth.

service_uri

string

The URI where webhooks should be sent.

Required when setting this receiver.

tenant_id

string

Indicates the tenant id for aad auth.

use_aad_auth

boolean

Indicates whether or not use AAD authentication.

Defaults to False when not set (server side default).

Choices:

• false
• true

use_common_alert_schema

boolean

Indicates whether to use common alert schema.

Defaults to False when not set (server side default).

Choices:

• false
• true

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.

actiongroup

dictionary

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: {"arm_role_receivers": [], "automation_runbook_receivers": [], "azure_app_push_receivers": [], "azure_function_receivers": [], "email_receivers": [{"email_address": "xxx@hostname.tld", "name": "sendmail", "use_common_alert_schema": true}], "enabled": true, "event_hub_receivers": [], "group_short_name": "shortname", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resougce_group_name/providers/microsoft.insights/actionGroups/action_group_name", "itsm_receivers": [], "location": "Global", "logic_app_receivers": [], "name": "action_group_name", "sms_receivers": [], "tags": {}, "type": "Microsoft.Insights/ActionGroups", "voice_receivers": [], "webhook_receivers": []}