The documentation you are viewing is for Dapr v1.6 which is an older version of Dapr. For up-to-date documentation, see the latest version.

Azure Service Bus Queues binding spec

Detailed documentation on the Azure Service Bus Queues binding component

Component format

To setup Azure Service Bus Queues binding create a component of type See this guide on how to create and apply a binding configuration.

kind: Component
  name: <NAME>
  namespace: <NAMESPACE>
  version: v1
  - name: connectionString
    value: "Endpoint=sb://************"
  - name: queueName
    value: queue1
  - name: ttlInSeconds
    value: 60

Spec metadata fields

Field Required Binding support Details Example
connectionString Y Input/Output The Service Bus connection string "Endpoint=sb://************"
queueName Y Input/Output The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase. "queuename"
ttlInSeconds N Output Parameter to set the default message time to live. If this parameter is omitted, messages will expire after 14 days. See also "60"

Azure Active Directory (AAD) authentication

The Azure Service Bus Queues binding component supports authentication using all Azure Active Directory mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of AAD authentication mechanism, see the docs for authenticating to Azure.

Binding support

This component supports both input and output binding interfaces.

This component supports output binding with the following operations:

  • create

Specifying a TTL per message

Time to live can be defined on queue level (as illustrated above) or at the message level. The value defined at message level overwrites any value set at queue level.

To set time to live at message level use the metadata section in the request body during the binding invocation.

The field name is ttlInSeconds.

curl -X POST http://localhost:3500/v1.0/bindings/myServiceBusQueue \
  -H "Content-Type: application/json" \
  -d '{
        "data": {
          "message": "Hi"
        "metadata": {
          "ttlInSeconds": "60"
        "operation": "create"