This document describes the current stable version of Kombu (5.3). For development docs, go here.

Azure Storage Queues Transport - kombu.transport.azurestoragequeues

Azure Storage Queues transport module for kombu.

More information about Azure Storage Queues: https://azure.microsoft.com/en-us/services/storage/queues/

Features

  • Type: Virtual

  • Supports Direct: Unreviewed

  • Supports Topic: Unreviewed

  • Supports Fanout: Unreviewed

  • Supports Priority: Unreviewed

  • Supports TTL: Unreviewed

Connection String

Connection string has the following formats:

azurestoragequeues://<STORAGE_ACCOUNT_ACCESS_KEY>@<STORAGE_ACCOUNT_URL>
azurestoragequeues://<SAS_TOKEN>@<STORAGE_ACCOUNT_URL>
azurestoragequeues://DefaultAzureCredential@<STORAGE_ACCOUNT_URL>
azurestoragequeues://ManagedIdentityCredential@<STORAGE_ACCOUNT_URL>

Note that if the access key for the storage account contains a forward slash (/), it will have to be regenerated before it can be used in the connection URL.

azurestoragequeues://DefaultAzureCredential@<STORAGE_ACCOUNT_URL>
azurestoragequeues://ManagedIdentityCredential@<STORAGE_ACCOUNT_URL>

If you wish to use an Azure Managed Identity you may use the DefaultAzureCredential format of the connection string which will use DefaultAzureCredential class in the azure-identity package. You may want to read the azure-identity documentation for more information on how the DefaultAzureCredential works.

https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python .. _Azure Managed Identity: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview

Transport Options

  • queue_name_prefix

Transport

class kombu.transport.azurestoragequeues.Transport(client, **kwargs)[source]

Azure Storage Queues transport.

class Channel(*args, **kwargs)

Azure Storage Queues channel.

basic_consume(queue, no_ack, *args, **kwargs)

Consume from queue.

property conninfo
domain_format: str = 'kombu%(vhost)s'
entity_name(name, table={33: 45, 34: 45, 35: 45, 36: 45, 37: 45, 38: 45, 39: 45, 40: 45, 41: 45, 42: 45, 43: 45, 44: 45, 45: 45, 46: 45, 47: 45, 58: 45, 59: 45, 60: 45, 61: 45, 62: 45, 63: 45, 64: 45, 91: 45, 92: 45, 93: 45, 94: 45, 95: 45, 96: 45, 123: 45, 124: 45, 125: 45, 126: 45}) → str

Format AMQP queue name into a valid Azure Storage Queue name.

no_ack: bool = True
property queue_name_prefix: str
property queue_service: None
property transport_options
classmethod as_uri(uri: str, include_password: bool = False, mask: str = '**') → str[source]

Customise the display format of the URI.

can_parse_url: bool = True

Set to True if Connection should pass the URL unmodified.

default_port: int | None = None

port number used when no port is specified.

static parse_uri(uri: str) → tuple[str | dict, str][source]
polling_interval: int = 1

Time to sleep between unsuccessful polls.

Channel

class kombu.transport.azurestoragequeues.Channel(*args, **kwargs)[source]

Azure Storage Queues channel.

basic_consume(queue, no_ack, *args, **kwargs)[source]

Consume from queue.

property conninfo
domain_format: str = 'kombu%(vhost)s'
entity_name(name, table={33: 45, 34: 45, 35: 45, 36: 45, 37: 45, 38: 45, 39: 45, 40: 45, 41: 45, 42: 45, 43: 45, 44: 45, 45: 45, 46: 45, 47: 45, 58: 45, 59: 45, 60: 45, 61: 45, 62: 45, 63: 45, 64: 45, 91: 45, 92: 45, 93: 45, 94: 45, 95: 45, 96: 45, 123: 45, 124: 45, 125: 45, 126: 45}) → str[source]

Format AMQP queue name into a valid Azure Storage Queue name.

no_ack: bool = True
property queue_name_prefix: str
property queue_service: None
property transport_options