azure_rm_eventgrid_subscription

Create, update or delete Azure Event Grid subscriptions

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_eventgrid_subscription

Synopsis

Create, update or delete Azure Event Grid subscriptions

Parameters

Name	Type	Required	Default	Description
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.
advanced_filter	list			An advanced filter enables filtering of events based on a specific event property.
KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE …]
Examples
data.Color StringIn Blue Red Orange Yellow
data.Color StringNotIn Blue Red Orange Yellow
subject StringContains Blue Red
subject StringNotContains Blue Red
subject StringBeginsWith Blue Red
subject StringNotBeginsWith Blue Red
subject StringEndsWith img png jpg
subject StringNotEndsWith img png jpg
data.property1 NumberIn 5 10 20
data.property1 NumberInRange 5,10 20,30 40,50
data.property2 NumberNotIn 100 200 300
data.property2 NumberNotInRange 100,110 200,210 300,310
data.property3 NumberLessThan 100
data.property2 NumberLessThanOrEquals 100
data.property3 NumberGreaterThan 100
data.property2 NumberGreaterThanOrEquals 100
data.property3 BoolEquals true
data.property3 IsNullOrUndefined
data.property3 IsNotNull
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.
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.
azure_active_directory_application_id_or_uri	string			The Azure Active Directory Application Id or Uri to get the access token that will be included as the bearer token in delivery requests. Applicable only for webhook as a destination.
azure_active_directory_tenant_id	string			The Azure Active Directory Tenant Id to get the access token that will be included as the bearer token in delivery requests. Applicable only for webhook as a destination.
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.
deadletter_endpoint	string			The Azure resource ID of an Azure Storage blob container destination where EventGrid should deadletter undeliverable events for this event subscription.
delivery_attribute_mapping	list			Add delivery attribute mapping to send additional information via HTTP headers when delivering events. This attribute is valid for all destination types except StorageQueue.
Format attribute-name attribute-type attribute-value [attribute-is-secret]
somename dynamic somevalue true
somename2 static somevalue
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.
enable_advanced_filtering_on_arrays	bool			Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
endpoint	string			Endpoint where EventGrid should deliver events matching this event subscription. For webhook endpoint type, this should be the corresponding webhook URL. For other endpoint types, this should be the Azure resource identifier of the endpoint. It is expected that the destination endpoint to be already created and available for use before executing any Event Grid command.
endpoint_type	string		`webhook`	The type of the destination endpoint.
event_delivery_schema	string			The schema in which events should be delivered for this event subscription. By default, events will be delivered in the same schema in which they are published (based on the corresponding topic’s input schema).
event_ttl	int		`1440`	Event time to live (in minutes). Must be a number between 1 and 1440.
expiration_date	string			Date or datetime (in UTC, e.g. ‘2018-11-30T11:59:59+00:00’ or ‘2018-11-30’) after which the event subscription would expire. By default, there is no expiration for the event subscription.
included_event_types	list			A list of event types (e.g., Microsoft.Storage.BlobCreated and Microsoft.Storage.BlobDeleted). In order to subscribe to all default event types, do not specify any value for this argument. For event grid topics, event types are customer defined. For Azure events, e.g., Storage Accounts, IoT Hub, etc., you can query their event types using this CLI command ‘az eventgrid topic-type list-event-types’.
labels	list			A list of labels to associate with this event subscription.
log_mode	string			Parent argument.
log_path	string			Parent argument.
max_delivery_attempts	int		`30`	Maximum number of delivery attempts. Must be a number between 1 and 30.
max_events_per_batch	int			Maximum number of events in a batch. Must be a number between 1 and 5000.
name	string	yes		Name of the subscription.
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.
preferred_batch_size_in_kilobytes	int			Preferred batch size in kilobytes. Must be a number between 1 and 1024.
profile	string			Security profile found in ~/.azure/credentials file.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
source_resource_id	string	yes		Name of a resource id where the subscription exists or will be created.
state	string		`present`	State of the Eventgrid Event Subscription. Use C(present) to create or update and C(absent) to delete.
storage_queue_msg_ttl	int			Storage queue message time to live in seconds.
subject_begins_with	string			An optional string to filter events for an event subscription based on a prefix. Wildcard characters are not supported.
subject_case_sensitive	bool			Specify to indicate whether the subject fields should be compared in a case sensitive manner. True if flag present.
subject_ends_with	string			An optional string to filter events for an event subscription based on a suffix. Wildcard characters are not supported.
subscription_id	string			Your Azure subscription Id.
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.
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: Subscribe to custom topic
  azure.azcollection.azure_rm_eventgrid_subscription:
    name: subscription-xxxxx20070
    source_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.EventGrid/topics/topic-xxxxx20070
    endpoint: https://event-grid-site-xxxxx20070.azurewebsites.net/api/updates