azure.azcollection.azure_rm_eventgrid_topic module – Manage Eventgrid Topics
Note
This module is part of the azure.azcollection collection (version 3.13.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_topic.
New in azure.azcollection 3.13.0
Synopsis
Create, update ,delete and replace Eventgrid Topics.
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:
|
|
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:
|
|
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 extended location name. Required if kind=AzureArc. |
|
The extended location type. Required if kind=AzureArc. Choices:
|
|
Identity for the Server. |
|
Type of the managed identity Choices:
|
|
User Assigned Managed Identity |
|
List of inbound IP rules Default: |
|
Action to perform based ont the match or no match of the IpMask. Choices:
|
|
IP Address in CIDR notation e.g., 10.0.0.0/8 |
|
When input_schema is specified as CustomEventSchema, this parameter can be used to specify input mappings based on default values. You can use this parameter when your custom schema does not include a field that corresponds to one of the three fields supported by this parameter. |
|
Parameter name Choices:
|
|
Default value to use for Parameter when not in publish event. |
|
When input_schema is specified as CustomEventSchema, this parameter is used to specify input mappings based on field names. |
|
Parameter name Choices:
|
|
Corresponding value should specify the name of the field in the custom input schema. If a mapping for either ‘id’ or ‘eventtime’ is not provided, Event Grid will auto-generate a default value for these two fields. |
|
Schema in which incoming events will be published to this topic/domain. If you specify CustomEventSchema as the value for this parameter, you must also provide values for at least one of input_mapping_default_values / input_mapping_fields. Choices:
|
|
The kind of topic resource. Choices:
|
|
Valid azure location. Defaults to location of the resource group. |
|
Parent argument. |
|
Parent argument. |
|
Name of the topic. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
This determines if traffic is allowed over public network. Choices:
|
|
if Choices:
|
|
Name of a resource group where the topic exists or will be created. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the Eventgrid Topic. 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. |
|
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: Create a new Topic
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
location: westus2
- name: Create a new Topic with custom input mappings
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
location: westus2
input_schema: CustomEventSchema
input_mapping_fields:
- mapping_key: topic
mapping_value: myTopicField
- mapping_key: eventtype
mapping_value: myEventTypeField
input_mapping_default_values:
- mapping_key: subject
mapping_value: DefaultSubject
- mapping_key: dataversion
mapping_value: 1.0
- name: Create a new Topic that accepts events published in CloudEvents V1.0 schema
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
location: westus2
input_schema: CloudEventSchemaV1_0
- name: Create a new Topic which allows specific inbound ip rules with Basic Sku and system assigned
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
location: westus2
public_network_access: enabled
inbound_ip_rules:
- ipmask: 10.0.0.0/8
action: Allow
- ipmask: 10.2.0.0/8
action: Allow
identity:
- type: SystemAssigned
- name: Create a new topic in AzureArc targeting a custom location
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
location: eastus2euap
kind: azurearc
extended_location_name: /subscriptions/<subid>/resourcegroups/<rgname>/providers/microsoft.extendedlocation/customlocations/<cust-loc-name>
extended_location_type: customlocation
input_schema: CloudEventSchemaV1_0
- name: Delete the topic
azure.azcollection.azure_rm_eventgrid_topic:
resource_group: rg1
name: topic1
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Whether the resource is changed. Returned: always Sample: |
|
Eventgrid Topic. Returned: always |
|
Residncy boundary Returned: always Sample: |
|
Whether local auth is disabled Returned: always Sample: |
|
Rest API endpoint to use to post events Returned: always Sample: |
|
Resource ID. Returned: always Sample: |
|
Rules for network access Returned: when-enabled |
|
What action will be taken, Allow or Disallow Returned: always Sample: |
|
CIDR notation of the network to act on. Returned: always Sample: |
|
The input schema assigned to this Topic Returned: always Sample: |
|
Custom input schema mapping Returned: when-enabled Sample: |
|
Resource location. Returned: always Sample: |
|
Metric Resource ID. Returned: always Sample: |
|
The minimum TLS version allowed Returned: always Sample: |
|
Resource name. Returned: always Sample: |
|
The provisioning state. Returned: always Sample: |
|
Indicates if boot diagnostics are enabled. Returned: always Sample: |
|
Type of Eventgrid Returned: always Sample: |