azure.azcollection.azure_rm_eventgrid_subscription module – Manage Eventgrid Subscriptions

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.

advanced_filter

list / elements=string

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

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"

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"

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

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"

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 / elements=string

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

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

enable_advanced_filtering_on_arrays

boolean

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

Choices:

• false
• true

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

The type of the destination endpoint.

Choices:

• "azurefunction"
• "eventhub"
• "hybridconnection"
• "servicebusqueue"
• "servicebustopic"
• "storagequeue"
• "webhook" ← (default)

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

Choices:

• "CloudEventSchemaV1_0"
• "CustomInputSchema"
• "EventGridSchema"

event_ttl

integer

Event time to live (in minutes). Must be a number between 1 and 1440.

Default: 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 / elements=string

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 / elements=string

A list of labels to associate with this event subscription.

log_mode

string

Parent argument.

log_path

string

Parent argument.

max_delivery_attempts

integer

Maximum number of delivery attempts. Must be a number between 1 and 30.

Default: 30

max_events_per_batch

integer

Maximum number of events in a batch. Must be a number between 1 and 5000.

name

string / required

Name of the subscription.

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.

preferred_batch_size_in_kilobytes

integer

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

Name of a resource id where the subscription exists or will be created.

state

string

State of the Eventgrid Event Subscription. Use present to create or update and absent to delete.

Choices:

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

storage_queue_msg_ttl

integer

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

boolean

Specify to indicate whether the subject fields should be compared in a case sensitive manner. True if flag present.

Choices:

• false
• true

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

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.

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.

changed

boolean

Whether the resource is changed.

Returned: always

Sample: true

eventgrid_subscriptions

complex

List of Eventgrid subscriptions.

Returned: always

destination

complex

Details of the destination

Returned: always

endpoint_base_url

string

The base URL of the endpoint

Returned: always

Sample: "https://event-grid-site-xxxxx20070.azurewebsites.net/api/updates"

endpoint_type

string

The type of the endpoint

Returned: always

Sample: "WebHook"

max_events_per_batch

integer

How many events will be batched

Returned: always

Sample: 1

preferred_batch_size_in_kilobytes

integer

The preferred batch size in kilobytes

Returned: always

Sample: 64

event_delivery_schema

string

The type of Eventgrid Schema

Returned: always

Sample: "EventGridSchema"

filter

complex

Filter settings for which events to publish to endpoint

Returned: always

subject_begins_with

string

Filter on Subject beginning with this value

Returned: always

subject_ends_with

string

Filter on Subject ending with this value

Returned: always

id

string

The ID of the Eventgrid Subscription

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.EventGrid/topics/topic-xxxxx20070/providers/Microsoft.EventGrid/eventSubscriptions/subscription-xxxxx20070"

name

string

The name of the Eventgrid Subscription

Returned: always

Sample: "subscription-xxxxx20070"

provisioning_state

string

The provisioning state of this Eventgrid Subscription

Returned: always

Sample: "Succeeded"

retry_policy

complex

Retry policy for this Eventgrid Subscription

Returned: always

event_time_to_live_in_minutes

integer

Event time to live in minutes

Returned: always

Sample: 1440

max_delivery_attempts

integer

Max attempts to deliver to endpoint

Returned: always

Sample: 30

topic

string

The source resource id that the Eventgrid Subscription is subscribed to

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/microsoft.eventgrid/topics/topic-xxxxx20070"

type

string

The type of Eventgrid Subscription

Returned: always

Sample: "Microsoft.EventGrid/eventSubscriptions"