Struct azure_functions::bindings::ServiceBusTrigger

pub struct ServiceBusTrigger {
    pub message: ServiceBusMessage,
    pub delivery_count: i32,
    pub dead_letter_source: Option<String>,
    pub expiration_time: DateTime<Utc>,
    pub enqueued_time: DateTime<Utc>,
    pub message_id: String,
    pub content_type: Option<String>,
    pub reply_to: Option<String>,
    pub sequence_number: i64,
    pub to: Option<String>,
    pub label: Option<String>,
    pub correlation_id: Option<String>,
    pub user_properties: Map<String, Value>,
}

Represents a service bus trigger binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
queue_name	The name of the queue to monitor. Use only if monitoring a queue, not for a topic.
topic_name	The name of the topic to monitor. Use only if monitoring a topic, not for a queue.
subscription_name	The name of the subscription to monitor. Use only if monitoring a topic, not for a queue.
connection	The name of an app setting that contains the Service Bus connection string to use for this binding. Defaults to AzureWebJobsServiceBus.

Examples

An example that logs a message when a message is posted to a queue:

use azure_functions::{
    bindings::ServiceBusTrigger,
    func,
};

#[func]
#[binding(name = "trigger", queue_name = "example", connection = "connection")]
pub fn log_message(trigger: ServiceBusTrigger) {
    log::info!("{}", trigger.message.as_str().unwrap());
}

An example that logs a message when a message is posted to a topic and subscription:

use azure_functions::{bindings::ServiceBusTrigger, func};

#[func]
#[binding(
    name = "trigger",
    topic_name = "mytopic",
    subscription_name = "mysubscription",
    connection = "connection"
)]
pub fn log_topic_message(trigger: ServiceBusTrigger) {
    log::info!("{}", trigger.message.as_str().unwrap());
}

Fields

message: ServiceBusMessage

The message that triggered the function.

delivery_count: i32

The number of deliveries.

dead_letter_source: Option<String>

The dead letter source.

expiration_time: DateTime<Utc>

The time that the message expires.

enqueued_time: DateTime<Utc>

The time that the message was enqueued.

message_id: String

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

content_type: Option<String>

The content type identifier utilized by the sender and receiver for application specific logic.

reply_to: Option<String>

The reply to queue address.

sequence_number: i64

The unique number assigned to a message by the Service Bus.

to: Option<String>

The send to address.

label: Option<String>

The application specific label.

correlation_id: Option<String>

The correlation ID.

user_properties: Map<String, Value>

The application specific message properties.

Trait Implementations

impl Debug for ServiceBusTrigger

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.