Docs / Contact / connectors/azure-service-bus

Azure Service Bus

Provider: azure | Service: servicebus | Direction: Write

Azure Service Bus connector for sending messages to a queue or topic. This is a forward-only connector.

Required Permissions

The connection string's Shared Access Policy must include the Send claim, or (for role auth) the Contact service principal must have the Azure Service Bus Data Sender role.

Tip: Assign at the namespace or individual queue/topic level. Avoid the Manage claim unless you need administrative access.

Operation

When a message reaches this connector, it sends to the queue or topic named in the payload. The payload must supply:

Payload field Required Description
destination Yes Target queue or topic name
message Yes Message body to send

Connector Configuration

The connector is created with type: "cloud", provider: "azure", service_type: "servicebus", plus:

Field (config) Required Description
auth_type No api_key (default) or role. See below.
service_bus_conn Conditional Service Bus connection string (use ${secrets.servicebus_conn}). Required when auth_type is api_key.
service_bus_namespace Conditional Fully qualified namespace (e.g., myns.servicebus.windows.net). Required when auth_type is role.
Role-based (cross-tenant) authentication

Set auth_type: "role" to authenticate as the Contact Azure AD application registered in your tenant. Provide tenant_id (required) and service_bus_namespace; no connection string is needed.

Output

json

{
  "status": "completed",
  "data": {
    "status": "sent",
    "destination": "device-events"
  }
}

Example

Connector config (connection string):

json

{
  "type": "cloud",
  "provider": "azure",
  "service_type": "servicebus",
  "service_bus_conn": "${secrets.servicebus_conn}"
}

Connector config (cross-tenant role):

json

{
  "type": "cloud",
  "provider": "azure",
  "service_type": "servicebus",
  "auth_type": "role",
  "tenant_id": "00000000-0000-0000-0000-000000000000",
  "service_bus_namespace": "myns.servicebus.windows.net"
}