mirror of https://github.com/dapr/docs.git
53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
# Azure Service Bus Queues Binding Spec
|
|
|
|
```yaml
|
|
apiVersion: dapr.io/v1alpha1
|
|
kind: Component
|
|
metadata:
|
|
name: <NAME>
|
|
namespace: <NAMESPACE>
|
|
spec:
|
|
type: bindings.azure.servicebusqueues
|
|
metadata:
|
|
- name: connectionString
|
|
value: "sb://************"
|
|
- name: queueName
|
|
value: queue1
|
|
- name: ttlInSeconds
|
|
value: 60
|
|
```
|
|
|
|
- `connectionString` is the Service Bus connection string.
|
|
- `queueName` is the Service Bus queue name.
|
|
- `ttlInSeconds` is an optional parameter to set the default message [time to live](https://docs.microsoft.com/azure/service-bus-messaging/message-expiration). If this parameter is omitted, messages will expire after 14 days.
|
|
|
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
|
|
## Specifying a time to live on message level
|
|
|
|
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`.
|
|
|
|
Example:
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3500/v1.0/bindings/myServiceBusQueue \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"data": {
|
|
"message": "Hi"
|
|
},
|
|
"metadata": {
|
|
"ttlInSeconds": "60"
|
|
},
|
|
"operation": "create"
|
|
}'
|
|
```
|
|
|
|
## Output Binding Supported Operations
|
|
|
|
* create
|