Skip to content

ServicebusClient

Attributes

SendMessagesInput module-attribute 

SendMessagesInput = List['ServiceBusMessage']

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, Any]] = 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] = field(default=None, metadata={'wire_name': 'ContentData'})

Content of the message

content_type class-attribute instance-attribute 
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Content type of the message content

properties class-attribute instance-attribute 
properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Key-value pairs for each brokered property

message_id class-attribute instance-attribute 
message_id: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'To'})

Send to address

reply_to class-attribute instance-attribute 
reply_to: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ReplyToSessionId'})

Identifier of the session to reply to

label class-attribute instance-attribute 
label: Optional[str] = field(default=None, metadata={'wire_name': 'Label'})

Application specific label

scheduled_enqueue_time_utc class-attribute instance-attribute 
scheduled_enqueue_time_utc: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'SessionId'})

Identifier of the session

correlation_id class-attribute instance-attribute 
correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'CorrelationId'})

Identifier of the correlation

sequence_number class-attribute instance-attribute 
sequence_number: Optional[int] = field(default=None, metadata={'wire_name': 'SequenceNumber'})

Identifier of the sequence number

lock_token class-attribute instance-attribute 
lock_token: Optional[str] = field(default=None, 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] = field(default=None, 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] = field(default_factory=dict)

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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Name'})

The entity name

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

SubscriptionFilter dataclass 

SubscriptionFilter(correlation_filter: Optional[SubscriptionCorrelationFilter] = None)

Definition: SubscriptionFilter

SubscriptionCorrelationFilter dataclass 

SubscriptionCorrelationFilter(correlation_id: Optional[str] = None, label: Optional[str] = None, message_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = 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] = field(default=None, metadata={'wire_name': 'CorrelationId'})

Identifier of the correlation

label class-attribute instance-attribute 
label: Optional[str] = field(default=None, metadata={'wire_name': 'Label'})

Application specific label

message_id class-attribute instance-attribute 
message_id: Optional[str] = field(default=None, 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, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Key-value pairs for each brokered property

reply_to class-attribute instance-attribute 
reply_to: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ReplyToSessionId'})

Identifier of the session to reply to

session_id class-attribute instance-attribute 
session_id: Optional[str] = field(default=None, metadata={'wire_name': 'SessionId'})

Identifier of the session

to class-attribute instance-attribute 
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Send to address

content_type class-attribute instance-attribute 
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Content type of the message content

ServicebusClient 

ServicebusClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

send_message_async async 
send_message_async(input: ServiceBusMessage, entity_name: str, system_properties: Optional[str] = None) -> None

Send message

This operation sends a message to a queue or topic.

send_messages_async async 
send_messages_async(input: SendMessagesInput, entity_name: str, system_properties: Optional[str] = None) -> None

Send one or more messages

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

complete_message_in_queue_async async 
complete_message_in_queue_async(queue_name: str, lock_token: str, queue_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Complete the message in a queue

The operation completes a message in a queue.

abandon_message_in_queue_async async 
abandon_message_in_queue_async(queue_name: str, lock_token: str, queue_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Abandon the message in a queue

The operation abandons a message in a queue.

get_deferred_message_from_queue_async async 
get_deferred_message_from_queue_async(queue_name: str, sequence_number: int, queue_type: Optional[str] = None, session_id: Optional[str] = None) -> dict[str, Any] | None

Get deferred message from a queue

The operation gets a deferred message from a queue.

defer_message_in_queue_async async 
defer_message_in_queue_async(queue_name: str, lock_token: str, queue_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Defer the message in a queue

The operation defers a message in a queue.

dead_letter_message_in_queue_async async 
dead_letter_message_in_queue_async(queue_name: str, lock_token: str, session_id: Optional[str] = None, dead_letter_reason: Optional[str] = None, dead_letter_error_description: Optional[str] = None) -> None

Dead-letter the message in a queue

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

renew_lock_on_message_in_queue_async async 
renew_lock_on_message_in_queue_async(queue_name: str, lock_token: str, queue_type: Optional[str] = None) -> None

Renew lock on the message in a queue

The operation renews lock on a message in a queue.

get_messages_from_queue_with_peek_lock_async async 
get_messages_from_queue_with_peek_lock_async(queue_name: str, max_message_count: Optional[int] = None, queue_type: Optional[str] = None, session_id: Optional[str] = None) -> dict[str, Any] | None

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.

close_session_in_queue_async async 
close_session_in_queue_async(queue_name: str, session_id: str) -> None

Close a session in a queue

The operation closes a session in a queue.

renew_lock_on_session_in_queue_async async 
renew_lock_on_session_in_queue_async(queue_name: str, session_id: str) -> None

Renew lock on the session in a queue

The operation renews a session in a queue.

complete_message_in_topic_async async 
complete_message_in_topic_async(topic_name: str, subscription_name: str, lock_token: str, subscription_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Complete the message in a topic subscription

The operation completes a message in a topic subscription.

abandon_message_in_topic_async async 
abandon_message_in_topic_async(topic_name: str, subscription_name: str, lock_token: str, subscription_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Abandon the message in a topic subscription

The operation abandons a message in a topic subscription.

get_deferred_message_from_topic_async async 
get_deferred_message_from_topic_async(topic_name: str, subscription_name: str, sequence_number: int, subscription_type: Optional[str] = None, session_id: Optional[str] = None) -> dict[str, Any] | None

Get deferred message from a topic subscription

The operation gets a deferred message from a topic subscription.

defer_message_in_topic_async async 
defer_message_in_topic_async(topic_name: str, subscription_name: str, lock_token: str, subscription_type: Optional[str] = None, session_id: Optional[str] = None) -> None

Defer the message in a topic subscription

The operation defers a message in a topic subscription.

dead_letter_message_in_topic_async async 
dead_letter_message_in_topic_async(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) -> None

Dead-letter the message in a topic subscription

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

renew_lock_on_message_in_topic_async async 
renew_lock_on_message_in_topic_async(topic_name: str, subscription_name: str, lock_token: str, subscription_type: Optional[str] = None) -> None

Renew lock on the message in a topic subscription

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

create_topic_subscription_async async 
create_topic_subscription_async(input: CreateTopicSubscriptionInput, topic_name: str, subscription_name: str, subscription_filter_type: Optional[str] = None) -> dict[str, Any] | None

Create a topic subscription

The operation creates a topic subscription.

delete_topic_subscription_async async 
delete_topic_subscription_async(topic_name: str, subscription_name: str) -> None

Delete a topic subscription

The operation deletes a topic subscription.

get_messages_from_topic_with_peek_lock_async async 
get_messages_from_topic_with_peek_lock_async(topic_name: str, subscription_name: str, max_message_count: Optional[int] = None, subscription_type: Optional[str] = None, session_id: Optional[str] = None) -> dict[str, Any] | None

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.

close_session_in_topic_async async 
close_session_in_topic_async(topic_name: str, subscription_name: str, session_id: str) -> None

Close a session in the topic

The operation closes a session in the topic.

renew_lock_on_session_in_topic_async async 
renew_lock_on_session_in_topic_async(topic_name: str, subscription_name: str, session_id: str) -> None

Renew lock on the session in a topic subscription

The operation renews a session in a topic subscription.

get_entities_async async 
get_entities_async() -> dict[str, Any] | None

Get all entities

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

get_system_properties_async async 
get_system_properties_async() -> dict[str, Any] | None

Get the list of system properties

This operation gets list of properties.

get_queues_async async 
get_queues_async() -> dict[str, Any] | None

Get all queues

This operation gets all queues in the Service Bus namespace.

get_session_options_async async 
get_session_options_async() -> dict[str, Any] | None

Get session options

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

get_topics_async async 
get_topics_async() -> dict[str, Any] | None

Get all topics

This operation gets all topics in the Service Bus namespace.

get_subscriptions_async async 
get_subscriptions_async(topic_name: str) -> dict[str, Any] | None

Get the subscriptions for a topic

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

get_subscription_filter_async async 
get_subscription_filter_async(subscription_filter_type: str) -> dict[str, Any] | None

Get metadata of a filter

Get metadata of a filter.