---
title: Microsoft Azure Service Bus
slug: connectors/microsoft-azure-service-bus
docTags: 
createdAt: 2026-06-09T16:30:27.088Z
---

The Microsoft Azure Service Bus connector facilitates the automation of message queuing and retrieval within the Azure cloud environment.

Microsoft Azure Service Bus is a highly-reliable cloud messaging service between applications and services. The Azure Service Bus connector for Swimlane Turbine enables automated message retrieval from Azure Service Bus queues, enhancing the efficiency of security workflows. By integrating this connector, users can fetch messages in batches, specify queue names, and set wait times for message availability, all within the Swimlane platform. This seamless integration empowers users to streamline their security operations by leveraging Azure's robust messaging infrastructure without writing a single line of code.

### Limitations

None to date.

### Supported Versions

This Microsoft Azure Service Bus connector uses the latest Version.

## Configuration

### Prerequisites

To utilize the Microsoft Azure Service Bus connector within Swimlane Turbine, ensure you have the following:

- A valid Azure Service Bus connection string to authenticate and establish a connection:
  - Connection String: The secure key that enables clients to connect to the Azure Service Bus namespace and perform operations on the messaging entities.

## Authentication Methods

### Custom Authentication with the following parameters:

- A Microsoft Azure Service Bus connection string:
  - Connection String:  This connection string should be obtained from your Azure Service Bus namespace and it typically includes the endpoint, Shared Access Signature (SAS) key name, and SAS key value.

### Setup Instructions

- Go to the **Azure Portal** and find your **Service Bus namespace**.
- Under Settings, select **Shared Access Policies**.
- Choose the policy, typically **RootManageSharedAccessKey**, and copy the **Primary Connection String**.

## Capabilities

This Connector provides the following capabilities:

- Retrieve Messages from Message Queue

### Retrieve Messages from Message Queue

- Get Messages from a Batch [Click Here](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-python-how-to-use-queues?tabs=connection-string#receive-messages-from-a-queue).

## Additional Documentation

- [Microsoft Azure Service Bus Connector Documentation](https://docs.swimlane.com/connectors/microsoft-azure-service-bus)
- [Microsoft Azure Service Bus API Documentation](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-python-how-to-use-queues?tabs=connection-string)
- [Microsoft Azure Service Bus Authentication Guide](https://docs.swimlane.com/authentication-guides/microsoft-azure-service-bus)

# Configurations

## Microsoft Azure Service Bus Authentication

Authenticates using a Microsoft Azure Service Bus connection string.

### Configuration Parameters

| **Parameter**      | **Description**                             | **Type** | **Required** |
| ------------------ | ------------------------------------------- | -------- | ------------ |
| connection\_string | The connection string to authenticate with. | string   | Required     |
| verify\_ssl        | Verify SSL certificate.                     | boolean  | Optional     |
| http\_proxy        | A proxy to route requests through.          | string   | Optional     |

# Actions

## Retrieve Messages from Message Queue

Retrieves a batch of messages from a specified Azure Service Bus queue, with configurable batch size and wait time.

### Endpoint

- **Method:** `GET`

### Input

| **Argument Name** | **Type** | **Required** | **Description**                                |
| ----------------- | -------- | ------------ | ---------------------------------------------- |
| `batch_size`      | number   | Required     | The number of messages to retrieve.            |
| `wait_time`       | number   | Required     | The time to wait for messages to be available. |
| `queue_name`      | string   | Required     | The name of the queue.                         |

### Input Example

`{"batch_size":10,"wait_time":5,"queue_name":"myqueue"}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `headers`     | object   | HTTP headers for the request     |
| `reason`      | string   | Response reason phrase           |
| `messages`    | array    | Response message                 |
| `count`       | number   | Count value                      |

### Output Example

`{"status_code":204,"headers":{},"reason":"OK","messages":[],"count":0}`

# Response Headers

| **Header**   | **Description**                                       | **Example**                   |
| ------------ | ----------------------------------------------------- | ----------------------------- |
| Content-Type | The media type of the resource                        | application/json              |
| Date         | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |
