ServicebusClient

Attributes

SendMessagesInput module-attribute

SendMessagesInput = List['ServiceBusMessage | Mapping[str, Any]']

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetMessageFromQueue': {'operation_id': 'GetMessageFromQueue', 'path': '/{connectionId}/{queueName}/messages/head', 'method': 'get', 'required_parameters': ['queueName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetNewMessageFromQueueWithPeekLock': {'operation_id': 'GetNewMessageFromQueueWithPeekLock', 'path': '/{connectionId}/{queueName}/messages/head/peek', 'method': 'get', 'required_parameters': ['queueName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetMessagesFromQueue': {'operation_id': 'GetMessagesFromQueue', 'path': '/{connectionId}/{queueName}/messages/batch/head', 'method': 'get', 'required_parameters': ['queueName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetNewMessagesFromQueueWithPeekLock': {'operation_id': 'GetNewMessagesFromQueueWithPeekLock', 'path': '/{connectionId}/{queueName}/messages/batch/head/peek', 'method': 'get', 'required_parameters': ['queueName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetMessageFromTopic': {'operation_id': 'GetMessageFromTopic', 'path': '/{connectionId}/{topicName}/subscriptions/{subscriptionName}/messages/head', 'method': 'get', 'required_parameters': ['topicName', 'subscriptionName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetNewMessageFromTopicWithPeekLock': {'operation_id': 'GetNewMessageFromTopicWithPeekLock', 'path': '/{connectionId}/{topicName}/subscriptions/{subscriptionName}/messages/head/peek', 'method': 'get', 'required_parameters': ['topicName', 'subscriptionName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetMessagesFromTopic': {'operation_id': 'GetMessagesFromTopic', 'path': '/{connectionId}/{topicName}/subscriptions/{subscriptionName}/messages/batch/head', 'method': 'get', 'required_parameters': ['topicName', 'subscriptionName'], 'callback_payload_type': 'ServiceBusMessage'}, 'GetNewMessagesFromTopicWithPeekLock': {'operation_id': 'GetNewMessagesFromTopicWithPeekLock', 'path': '/{connectionId}/{topicName}/subscriptions/{subscriptionName}/messages/batch/head/peek', 'method': 'get', 'required_parameters': ['topicName', 'subscriptionName'], 'callback_payload_type': 'ServiceBusMessage'}}

Classes

ServiceBusMessage dataclass

ServiceBusMessage(*, content_data: Optional[str] = None, content_type: Optional[str] = None, properties: Optional[Dict[str, str]] = None, message_id: Optional[str] = None, to: Optional[str] = None, reply_to: Optional[str] = None, reply_to_session_id: Optional[str] = None, label: Optional[str] = None, scheduled_enqueue_time_utc: Optional[str] = None, session_id: Optional[str] = None, correlation_id: Optional[str] = None, sequence_number: Optional[int] = None, lock_token: Optional[str] = None, time_to_live: Optional[str] = None)

Response for When a message is received in a queue (auto-complete)

Attributes

content_data class-attribute instance-attribute

content_data: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentData'})

Content of the message

content_type class-attribute instance-attribute

content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentType'})

Content type of the message content

properties class-attribute instance-attribute

properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Properties'})

Key-value pairs for each brokered property

message_id class-attribute instance-attribute

message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MessageId'})

This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.

to class-attribute instance-attribute

to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'To'})

Send to address

reply_to class-attribute instance-attribute

reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})

Address of the queue to reply to

reply_to_session_id class-attribute instance-attribute

reply_to_session_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyToSessionId'})

Identifier of the session to reply to

label class-attribute instance-attribute

label: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Label'})

Application specific label

scheduled_enqueue_time_utc class-attribute instance-attribute

scheduled_enqueue_time_utc: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ScheduledEnqueueTimeUtc'})

Date and time, in UTC, when the message will be added to the queue

session_id class-attribute instance-attribute

session_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SessionId'})

Identifier of the session

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CorrelationId'})

Identifier of the correlation

sequence_number class-attribute instance-attribute

sequence_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SequenceNumber'})

Identifier of the sequence number

lock_token class-attribute instance-attribute

lock_token: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LockToken'})

The lock token of the message as a string.

time_to_live class-attribute instance-attribute

time_to_live: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeToLive'})

This is the duration, in ticks, that a message is valid. The duration starts from when the message is sent to the Service Bus.

CreateTopicSubscriptionInput dataclass

CreateTopicSubscriptionInput(*, additional_properties: Dict[str, Any] = dict())

Create a topic subscription

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Subscription dataclass

Subscription(*, subscription_name: Optional[str] = None)

Response for Create a topic subscription

Attributes

subscription_name class-attribute instance-attribute

subscription_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SubscriptionName'})

Subscription name.

ServiceBusEntity dataclass

ServiceBusEntity(*, name: Optional[str] = None, display_name: Optional[str] = None)

Response for Get all entities

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The entity name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name for the entity

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Response for Get metadata of a filter

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SubscriptionFilter dataclass

SubscriptionFilter(*, correlation_filter: Optional[SubscriptionCorrelationFilter | Mapping[str, Any]] = None)

Definition: SubscriptionFilter

SubscriptionCorrelationFilter dataclass

SubscriptionCorrelationFilter(*, correlation_id: Optional[str] = None, label: Optional[str] = None, message_id: Optional[str] = None, properties: Optional[Dict[str, str]] = None, reply_to: Optional[str] = None, reply_to_session_id: Optional[str] = None, session_id: Optional[str] = None, to: Optional[str] = None, content_type: Optional[str] = None)

Definition: SubscriptionCorrelationFilter

Attributes

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CorrelationId'})

Identifier of the correlation

label class-attribute instance-attribute

label: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Label'})

Application specific label

message_id class-attribute instance-attribute

message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MessageId'})

This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.

properties class-attribute instance-attribute

properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Properties'})

Key-value pairs for each brokered property

reply_to class-attribute instance-attribute

reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})

Address of the queue to reply to

reply_to_session_id class-attribute instance-attribute

reply_to_session_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyToSessionId'})

Identifier of the session to reply to

session_id class-attribute instance-attribute

session_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SessionId'})

Identifier of the session

to class-attribute instance-attribute

to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'To'})

Send to address

content_type class-attribute instance-attribute

content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentType'})

Content type of the message content

ServicebusClient

ServicebusClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for servicebus connector.

Initialize a ServicebusClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

send_message async

send_message(input: ServiceBusMessage | Mapping[str, Any], entity_name: str, *, system_properties: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Send message

This operation sends a message to a queue or topic.

Swagger operation ID: SendMessage.

Parameters:

Name	Type	Description	Default
input	ServiceBusMessage | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
entity_name	str	Name of the queue or topic.	required
system_properties	Optional[str]	System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

send_messages async

send_messages(input: SendMessagesInput, entity_name: str, *, system_properties: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Send one or more messages

This operation sends one or more messages to a queue or topic.

Swagger operation ID: SendMessages.

Parameters:

Name	Type	Description	Default
input	SendMessagesInput	The request body.	required
entity_name	str	Name of the queue or topic.	required
system_properties	Optional[str]	System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

complete_message_in_queue async

complete_message_in_queue(queue_name: str, lock_token: str, *, queue_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Complete the message in a queue

The operation completes a message in a queue.

Swagger operation ID: CompleteMessageInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
lock_token	str	Lock token of the message to complete.	required
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

abandon_message_in_queue async

abandon_message_in_queue(queue_name: str, lock_token: str, *, queue_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Abandon the message in a queue

The operation abandons a message in a queue.

Swagger operation ID: AbandonMessageInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
lock_token	str	Lock token of the message to abandon.	required
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_deferred_message_from_queue async

get_deferred_message_from_queue(queue_name: str, sequence_number: int, *, queue_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get deferred message from a queue

The operation gets a deferred message from a queue.

Swagger operation ID: GetDeferredMessageFromQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
sequence_number	int	Sequence number of message.	required
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

defer_message_in_queue async

defer_message_in_queue(queue_name: str, lock_token: str, *, queue_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Defer the message in a queue

The operation defers a message in a queue.

Swagger operation ID: DeferMessageInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
lock_token	str	Lock token of the message to defer.	required
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

dead_letter_message_in_queue async

dead_letter_message_in_queue(queue_name: str, lock_token: str, *, session_id: Optional[str] = None, dead_letter_reason: Optional[str] = None, dead_letter_error_description: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Dead-letter the message in a queue

The operation moves the message to the Dead-Letter Queue.

Swagger operation ID: DeadLetterMessageInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
lock_token	str	Lock token of the message to dead-letter.	required
session_id	Optional[str]	Session id.	None
dead_letter_reason	Optional[str]	Dead letter reason.	None
dead_letter_error_description	Optional[str]	Dead letter error description.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

renew_lock_on_message_in_queue async

renew_lock_on_message_in_queue(queue_name: str, lock_token: str, *, queue_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Renew lock on the message in a queue

The operation renews lock on a message in a queue.

Swagger operation ID: RenewLockOnMessageInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
lock_token	str	Lock token of the message to renew lock.	required
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_messages_from_queue_with_peek_lock

list_messages_from_queue_with_peek_lock(queue_name: str, *, max_message_count: Optional[int] = None, queue_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get messages from a queue (peek-lock)

The operation receives messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMessagesFromQueueWithPeekLock.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
max_message_count	Optional[int]	The maximum number of messages to return in the batch.	None
queue_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

close_session_in_queue async

close_session_in_queue(queue_name: str, session_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Close a session in a queue

The operation closes a session in a queue.

Swagger operation ID: CloseSessionInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of a queue.	required
session_id	str	Session id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

renew_lock_on_session_in_queue async

renew_lock_on_session_in_queue(queue_name: str, session_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Renew lock on the session in a queue

The operation renews a session in a queue.

Swagger operation ID: RenewLockOnSessionInQueue.

Parameters:

Name	Type	Description	Default
queue_name	str	Name of the queue.	required
session_id	str	Session id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

complete_message_in_topic async

complete_message_in_topic(topic_name: str, subscription_name: str, lock_token: str, *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Complete the message in a topic subscription

The operation completes a message in a topic subscription.

Swagger operation ID: CompleteMessageInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
lock_token	str	Lock token of the message to complete.	required
subscription_type	Optional[str]	Subscription type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

abandon_message_in_topic async

abandon_message_in_topic(topic_name: str, subscription_name: str, lock_token: str, *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Abandon the message in a topic subscription

The operation abandons a message in a topic subscription.

Swagger operation ID: AbandonMessageInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
lock_token	str	Lock token of the message to abandon.	required
subscription_type	Optional[str]	Subscription type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_deferred_message_from_topic async

get_deferred_message_from_topic(topic_name: str, subscription_name: str, sequence_number: int, *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get deferred message from a topic subscription

The operation gets a deferred message from a topic subscription.

Swagger operation ID: GetDeferredMessageFromTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
sequence_number	int	Sequence number of message.	required
subscription_type	Optional[str]	Queue type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

defer_message_in_topic async

defer_message_in_topic(topic_name: str, subscription_name: str, lock_token: str, *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Defer the message in a topic subscription

The operation defers a message in a topic subscription.

Swagger operation ID: DeferMessageInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
lock_token	str	Lock token of the message to defer.	required
subscription_type	Optional[str]	Subscription type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

dead_letter_message_in_topic async

dead_letter_message_in_topic(topic_name: str, subscription_name: str, lock_token: str, *, session_id: Optional[str] = None, dead_letter_reason: Optional[str] = None, dead_letter_error_description: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Dead-letter the message in a topic subscription

The operation moves the message to the topic Dead-Letter Queue.

Swagger operation ID: DeadLetterMessageInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
lock_token	str	Lock token of the message to dead-letter.	required
session_id	Optional[str]	Session id.	None
dead_letter_reason	Optional[str]	Dead letter reason.	None
dead_letter_error_description	Optional[str]	Dead letter error description.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

renew_lock_on_message_in_topic async

renew_lock_on_message_in_topic(topic_name: str, subscription_name: str, lock_token: str, *, subscription_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Renew lock on the message in a topic subscription

The operation renews lock on a message in a topic subscription.

Swagger operation ID: RenewLockOnMessageInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
lock_token	str	Lock token of the message to renew lock.	required
subscription_type	Optional[str]	Subscription type - Main or DeadLetter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_topic_subscription async

create_topic_subscription(input: CreateTopicSubscriptionInput | Mapping[str, Any], topic_name: str, subscription_name: str, *, subscription_filter_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a topic subscription

The operation creates a topic subscription.

Swagger operation ID: CreateTopicSubscription.

Parameters:

Name	Type	Description	Default
input	CreateTopicSubscriptionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
subscription_filter_type	Optional[str]	Filter type.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_topic_subscription async

delete_topic_subscription(topic_name: str, subscription_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a topic subscription

The operation deletes a topic subscription.

Swagger operation ID: DeleteTopicSubscription.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_messages_from_topic_with_peek_lock

list_messages_from_topic_with_peek_lock(topic_name: str, subscription_name: str, *, max_message_count: Optional[int] = None, subscription_type: Optional[str] = None, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get messages from a topic subscription (peek-lock)

The operation receives messages from a topic subscription with peek-lock. If maximum message count is not provided, it reads 20 messages.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMessagesFromTopicWithPeekLock.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
max_message_count	Optional[int]	The maximum number of messages to return in the batch.	None
subscription_type	Optional[str]	Subscription type - Main or DeadLetter.	None
session_id	Optional[str]	Session id.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

close_session_in_topic async

close_session_in_topic(topic_name: str, subscription_name: str, session_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Close a session in the topic

The operation closes a session in the topic.

Swagger operation ID: CloseSessionInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
session_id	str	Session id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

renew_lock_on_session_in_topic async

renew_lock_on_session_in_topic(topic_name: str, subscription_name: str, session_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Renew lock on the session in a topic subscription

The operation renews a session in a topic subscription.

Swagger operation ID: RenewLockOnSessionInTopic.

Parameters:

Name	Type	Description	Default
topic_name	str	Name of the topic.	required
subscription_name	str	Name of the topic subscription.	required
session_id	str	Session id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_entities

list_entities(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get all entities

This operation gets all queues and topics in the Service Bus namespace.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEntities.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_system_properties

list_system_properties(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

Get the list of system properties

This operation gets list of properties.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSystemProperties.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_queues

list_queues(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

Get all queues

This operation gets all queues in the Service Bus namespace.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetQueues.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_session_options

list_session_options(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

Get session options

This operation gets the list of options for session handling - None, Next available.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSessionOptions.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_topics

list_topics(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

Get all topics

This operation gets all topics in the Service Bus namespace.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTopics.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_subscriptions

list_subscriptions(topic_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

Get the subscriptions for a topic

This operation gets the list of subscriptions for a topic in the Service Bus namespace.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSubscriptions.

Parameters:

Name	Type	Description	Default
topic_name	str	Topic name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_subscription_filter async

get_subscription_filter(subscription_filter_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get metadata of a filter

Get metadata of a filter.

Swagger operation ID: GetSubscriptionFilterV2.

Parameters:

Name	Type	Description	Default
subscription_filter_type	str	Subscription filter type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.