azure.azcollection.azure_rm_eventgrid_subscription_info module – List Eventgrid Event Subscriptions

Note

This module is part of the azure.azcollection collection (version 3.18.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_eventgrid_subscription_info.

New in azure.azcollection 3.13.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

List Eventgrid Event Subscriptions.

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
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"`
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"`
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`
location string	List by region.
log_mode string	Parent argument.
log_path string	Parent argument.
odata_query string	The query used to filter the search results using OData syntax.
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.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string	Name of a resource group to limit event subscriptions from. If not specified the subscription will be searched.
secret string	Azure client secret. Use when authenticating with a Service Principal.
source_resource_id string	Fully qualified identifier of the Azure resource whose event subscription needs to be listed.
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.

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 OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.
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.

Examples

- name: Get info on an event subscription
  azure.azcollection.azure_rm_eventgrid_subscription_info:
    location: westus3
    odata_query: "contains(name, 'PATTERN')"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Whether the resource is changed. Returned: always Sample: `false`
eventgrid_subscriptions complex	List of Eventgrid subscriptions. Returned: always
destination complex	Details of the destination Returned: always
delivery_attribute_mappings string	Mapping attributes for delivery 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"`
endpoint_url string	The URL of the endpoint Returned: always Sample: `"https://event-grid-site-xxxxx20070.azurewebsites.net/api/updates"`
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"`

Authors

Bill Peck (@p3ck)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_eventgrid_subscription_info_module.html