azure.azcollection.azure_rm_eventgrid_topic module – Manage Eventgrid Topics

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)

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

extended_location_name

string

The extended location name.

Required if kind=AzureArc.

extended_location_type

string

The extended location type.

Required if kind=AzureArc.

Choices:

• "customlocation"

identity

dictionary

Identity for the Server.

type

string

Type of the managed identity

Choices:

• "UserAssigned"
• "SystemAssigned" ← (default)
• "SystemAssigned UserAssigned"
• "None"

user_assigned_identities

list / elements=string

User Assigned Managed Identity

inbound_ip_rules

list / elements=dictionary

List of inbound IP rules

Default: []

action

string

Action to perform based ont the match or no match of the IpMask.

Choices:

• "Allow"
• "Deny"

ipmask

string

IP Address in CIDR notation e.g., 10.0.0.0/8

input_mapping_default_values

list / elements=dictionary

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.

mapping_key

string

Parameter name

Choices:

• "subject"
• "eventtype"
• "dataversion"

mapping_value

string

Default value to use for Parameter when not in publish event.

input_mapping_fields

list / elements=dictionary

When input_schema is specified as CustomEventSchema, this parameter is used to specify input mappings based on field names.

mapping_key

string

Parameter name

Choices:

• "id"
• "topic"
• "eventtime"
• "subject"
• "eventtype"
• "dataversion"

mapping_value

string

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.

input_schema

string

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:

• "CloudEventSchemaV1_0"
• "CustomEventSchema"
• "EventGridSchema" ← (default)

kind

string

The kind of topic resource.

Choices:

• "Azure" ← (default)
• "AzureArc"

location

string

Valid azure location. Defaults to location of the resource group.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

Name of the topic.

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.

public_network_access

string

This determines if traffic is allowed over public network.

Choices:

• "enabled" ← (default)
• "disabled"

regenerate_keys

list / elements=string

if present and topic exsists (ie update action) this will force the listed key to be regeneratd. This cannot be idempotent. Everytime this is called it will regenerate the key(s).

Choices:

• "key1"
• "key2"

resource_group

string / required

Name of a resource group where the topic exists or will be created.

secret

string

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

state

string

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

Choices:

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

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.

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_topic

complex

Eventgrid Topic.

Returned: always

data_residency_boundary

string

Residncy boundary

Returned: always

Sample: "WithinGeopair"

disable_local_auth

boolean

Whether local auth is disabled

Returned: always

Sample: false

endpoint

string

Rest API endpoint to use to post events

Returned: always

Sample: "https://myTopic-20070.westus3-1.eventgrid.azure.net/api/events"

id

string

Resource ID.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.EventGrid/topics/myTopic"

inbound_ip_rules

complex

Rules for network access

Returned: when-enabled

action

string

What action will be taken, Allow or Disallow

Returned: always

Sample: "Allow"

ip_mask

string

CIDR notation of the network to act on.

Returned: always

Sample: "10.0.0.0/8"

input_schema

string

The input schema assigned to this Topic

Returned: always

Sample: "EventGridSchema"

input_schema_mapping

string

Custom input schema mapping

Returned: when-enabled

Sample: "\"data_version\": {\n  \"default_value\": \"1.0\"\n},\n\"event_time\": {},\n\"event_type\": {\n  \"source_field\": \"myEventTypeField\"\n},\n\"id\": {},\n\"input_schema_mapping_type\": \"Json\",\n\"subject\": {\n  \"default_value\": \"DefaultSubject\"\n},\n\"topic\": {\n  \"source_field\": \"myTopicField\"\n}\n"

location

string

Resource location.

Returned: always

Sample: "westus3"

metric_resource_id

string

Metric Resource ID.

Returned: always

Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

minimum_tls_version_allowed

string

The minimum TLS version allowed

Returned: always

Sample: "1.0"

name

string

Resource name.

Returned: always

Sample: "myTopic"

provisioning_state

string

The provisioning state.

Returned: always

Sample: "Succeeded"

public_network_access

string

Indicates if boot diagnostics are enabled.

Returned: always

Sample: "Enabled"

type

string

Type of Eventgrid

Returned: always

Sample: "Microsoft.EventGrid/topics"