azure_rm_servicebusqueue

Manage Azure Service Bus queue

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_servicebusqueue

Synopsis

Manage Azure Service Bus queue

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
auto_delete_on_idle_in_seconds	int			Time idle interval after which a queue is automatically deleted.
The minimum duration is 5 minutes.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
dead_lettering_on_message_expiration	bool			A value that indicates whether a queue has dead letter support when a message expires.
default_message_time_to_live_seconds	int			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.
disable_instance_discovery	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
duplicate_detection_time_in_seconds	int			TimeSpan structure that defines the duration of the duplicate detection history.
enable_batched_operations	bool			Value that indicates whether server-side batched operations are enabled.
enable_express	bool			Value that indicates whether Express Entities are enabled.
An express topic or queue holds a message in memory temporarily before writing it to persistent storage.
enable_partitioning	bool			A value that indicates whether the topic or queue is to be partitioned across multiple message brokers.
forward_dead_lettered_messages_to	string			Queue or topic name to forward the Dead Letter message for a queue.
forward_to	string			Queue or topic name to forward the messages for a queue.
lock_duration_in_seconds	int			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.
log_mode	string			Parent argument.
log_path	string			Parent argument.
max_delivery_count	int			The maximum delivery count.
A message is automatically deadlettered after this number of deliveries.
max_message_size_in_kb	int			Maximum size (in KB) of the message payload that can be accepted by the queue.
This property is only used in Premium today and default is 1024.
max_size_in_mb	int			The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
name	string	yes		Name of the queue.
namespace	string	yes		Servicebus namespace name.
A namespace is a scoping container for all messaging components.
Multiple queues and topics can reside within a single namespace, and namespaces often serve as application containers.
oidc_token	string			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 C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			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 C(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.
requires_duplicate_detection	bool			A value indicating if this queue or topic requires duplicate detection.
requires_session	bool			A value that indicates whether the queue supports the concept of sessions.
resource_group	string	yes		Name of resource group.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
state	string		`present`	Assert the state of the queue. Use C(present) to create or update and use C(absent) to delete.
status	string			Status of the entity.
subscription_id	string			Your Azure subscription Id.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
x509_certificate_path	string			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.

Example

yaml

- name: Create a queue
  azure.azcollection.azure_rm_servicebusqueue:
      name: subqueue
      resource_group: myResourceGroup
      namespace: bar
      duplicate_detection_time_in_seconds: 600