Storage Queue Subscribers

Storage Queue subscribers deliver events to Azure Storage Queues.

Settings

Setting	Description
name	The name of the subscriber.
connectionString	The Storage Queue connection string. Can be omitted if storageQueueConnectionString is set at the topic level.
queueName	The name of the queue to send events to.
disabled	(Optional) Set to true to disable this subscriber. Events will not be delivered to disabled subscribers.
deliverySchema	(Optional) Override the delivery schema. Values: EventGridSchema or CloudEventV1_0.
filter	(Optional) Event filtering configuration. See Filtering.
retryPolicy	(Optional) Retry policy settings. See Retry and Dead-Letter.
deadLetter	(Optional) Dead-letter settings. See Retry and Dead-Letter.

Basic Example

{
  "subscribers": {
    "storageQueue": [
      {
        "name": "OrdersArchive",
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=...;EndpointSuffix=core.windows.net",
        "queueName": "orders-archive"
      }
    ]
  }
}

Using Topic-Level Connection String

You can set the connection string at the topic level and have subscribers inherit it:

{
  "topics": [
    {
      "name": "OrdersTopic",
      "port": 60101,
      "storageQueueConnectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=...;EndpointSuffix=core.windows.net",
      "subscribers": {
        "storageQueue": [
          {
            "name": "OrdersArchive",
            "queueName": "orders-archive"
          }
        ]
      }
    }
  ]
}

Filtering Events

You can filter which events are delivered to a subscriber. See Filtering for the complete filtering reference.

{
  "subscribers": {
    "storageQueue": [
      {
        "name": "FailedOrdersArchive",
        "queueName": "failed-orders",
        "filter": {
          "includedEventTypes": ["Order.Failed"],
          "advancedFilters": [
            {
              "operatorType": "StringContains",
              "key": "data.errorCode",
              "values": ["PAYMENT_DECLINED", "INVENTORY_UNAVAILABLE"]
            }
          ]
        }
      }
    ]
  }
}

Complete Example

{
  "topics": [
    {
      "name": "OrdersTopic",
      "port": 60101,
      "key": "TheLocal+DevelopmentKey=",
      "storageQueueConnectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=...;EndpointSuffix=core.windows.net",
      "subscribers": {
        "storageQueue": [
          {
            "name": "OrdersStorageQueueSubscription",
            "queueName": "orders-archive",
            "deliverySchema": "CloudEventV1_0",
            "retryPolicy": {
              "enabled": true,
              "maxDeliveryAttempts": 5
            }
          }
        ]
      }
    }
  ]
}

Related Topics

• Configuration - Topic-level connection string settings
• Retry and Dead-Letter - Retry policies and dead-lettering
• Docker - Using with Azurite storage emulator