azure_rm_servicebustopicsubscription – Manage Azure Service Bus subscription

New in version 2.8.

Synopsis

  • Create, update or delete an Azure Service Bus subscriptions.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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 2.6
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 2.5
 Default:
"latest"
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.
append_tags
boolean
    Choices:
  • no
  • yes ←
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.
auth_source
string
added in 2.5
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
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.
auto_delete_on_idle_in_seconds
integer
Time idle interval after which a subscription is automatically deleted.
The minimum duration is 5 minutes.
cert_validation_mode
string
added in 2.5
    Choices:
  • ignore
  • validate
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.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 2.4
 Default:
"AzureCloud"
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.
dead_lettering_on_filter_evaluation_exceptions
boolean
    Choices:
  • no
  • yes
Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
dead_lettering_on_message_expiration
boolean
    Choices:
  • no
  • yes
A value that indicates whether a subscription has dead letter support when a message expires.
default_message_time_to_live_seconds
integer
Default message timespan to live value.
This is the duration after which the message expires, starting from when the message is sent to Service Bus.
This is the default value used when TimeToLive is not set on a message itself.
duplicate_detection_time_in_seconds
integer
TimeSpan structure that defines the duration of the duplicate detection history.
enable_batched_operations
boolean
    Choices:
  • no
  • yes
Value that indicates whether server-side batched operations are enabled.
forward_dead_lettered_messages_to
-
Queue or topic name to forward the Dead Letter message for a subscription.
forward_to
-
Queue or topic name to forward the messages for a subscription.
lock_duration_in_seconds
integer
Timespan duration of a peek-lock.
The amount of time that the message is locked for other receivers.
The maximum value for LockDuration is 5 minutes.
max_delivery_count
integer
he maximum delivery count.
A message is automatically deadlettered after this number of deliveries.
name
- / required
name of the servicebus subscription.
namespace
- / required
Servicebus namespace name.
A namespace is a scoping container for all messaging components.
Multiple subscriptions and topics can reside within a single namespace, and namespaces often serve as application containers.
password
-
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.
requires_session
boolean
    Choices:
  • no
  • yes
A value that indicates whether the subscription supports the concept of sessions.
resource_group
- / required
name of resource group.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
-
    Choices:
  • absent
  • present ←
Assert the state of the servicebus subscription. Use 'present' to create or update and 'absent' to delete.
status
-
    Choices:
  • active
  • disabled
  • send_disabled
  • receive_disabled
Status of the entity.
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.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
topic
- / required
Topic name which the subscription subscribe to.

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 login command.

Examples

- name: Create a subscription
  azure_rm_servicebustopicsubscription:
      name: sbsub
      resource_group: myResourceGroup
      namespace: bar
      topic: subtopic

Return Values

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

Key Returned Description
id
string
 success
Current state of the subscription.


Status

Authors

  • Yuwei Zhou (@yuwzho)

Hint

If you notice any issues in this documentation you can edit this document to improve it.