title

Quickstart: Get started with Azure Service Bus queues (JavaScript)

description

This tutorial shows you how to send messages to and receive messages from Azure Service Bus queues using the JavaScript programming language.

author

spelluru

ms.author

spelluru

ms.date

06/13/2025

ms.topic

quickstart

ms.devlang

javascript

ms.custom

devx-track-js

mode-api

sfi-ropc-nochange

Quickstart: Send messages to and receive messages from Azure Service Bus queues (JavaScript)

[!div class="op_single_selector" title1="Select the programming language:"]

C#

Java

JavaScript

Python

This quickstart provides step-by-step instructions for a simple scenario of sending messages to a Service Bus queue and receiving them. In this quickstart, you complete the following tasks:

Create a Service Bus namespace, using the Azure portal.
Create a Service Bus queue, using the Azure portal.
Write a JavaScript application to use the @azure/service-bus package to:
- Send a set of messages to the queue.
- Receive those messages from the queue.

You can find prebuilt JavaScript and TypeScript samples for Azure Service Bus in the Azure SDK for JavaScript repository on GitHub.

If you're new to the service, see Service Bus overview before you begin.

Prerequisites

An Azure subscription. To complete this quickstart, you need an Azure account. You can activate your Monthly Azure credits for Visual Studio subscribers or sign-up for a free account.
Node.js LTS

Passwordless

To use this quickstart with your own Azure account:

Install Azure CLI, which provides the passwordless authentication to your developer machine.
Sign in with your Azure account at a command prompt with az login.
Use the same account when you add the appropriate data role to your resource.
Run the code in the same Command Prompt window.
Make a note of your queue name for your Service Bus namespace. You need that in the code.

Connection string

Make a note of the following values to use in the code:

Service Bus namespace connection string
Service Bus namespace queue you created

Note

This tutorial works with samples that you can copy and run using Nodejs. For instructions on how to create a Node.js application, see Create and deploy a Node.js application to an Azure Website, or Node.js cloud service using Windows PowerShell.

[!INCLUDE service-bus-create-namespace-portal]

[!INCLUDE service-bus-create-queue-portal]

[!INCLUDE service-bus-passwordless-template-tabbed]

Use Node Package Manager (NPM) to install the package

Passwordless

To install the required npm packages for Service Bus, open a Command Prompt window that has npm in its path and change the directory to the folder where you want to have your samples.

Install the following packages:

npm install @azure/service-bus @azure/identity

Connection string

To install the required npm packages for Service Bus, open a Command Prompt window that has npm in its path and change the directory to the folder where you want to have your samples.
Install the following package:
```
npm install @azure/service-bus
```

Send messages to a queue

The following sample code shows you how to send a message to a queue.

Passwordless

Sign in with the Azure CLI command az login for your local machine to provide the passwordless authentication required in this code.

Open a text editor, such as Visual Studio Code.

Create a file called send.js and paste the following code into it. This code sends the names of scientists as messages to your queue.

[!IMPORTANT] The passwordless credential is provided by using the DefaultAzureCredential.

const { ServiceBusClient } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

const messages = [
    { body: "Albert Einstein" },
    { body: "Werner Heisenberg" },
    { body: "Marie Curie" },
    { body: "Steven Hawking" },
    { body: "Isaac Newton" },
    { body: "Niels Bohr" },
    { body: "Michael Faraday" },
    { body: "Galileo Galilei" },
    { body: "Johannes Kepler" },
    { body: "Nikolaus Kopernikus" }
    ];

async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createSender() can also be used to create a sender for a topic.
    const sender = sbClient.createSender(queueName);

    try {
        // Tries to send all messages in a single batch.
        // Will fail if the messages cannot fit in a batch.
        // await sender.sendMessages(messages);

        // create a batch object
        let batch = await sender.createMessageBatch();
        for (let i = 0; i < messages.length; i++) {
            // for each message in the array

            // try to add the message to the batch
            if (!batch.tryAddMessage(messages[i])) {
                // if it fails to add the message to the current batch
                // send the current batch as it is full
                await sender.sendMessages(batch);

                // then, create a new batch
                batch = await sender.createMessageBatch();

                // now, add the message failed to be added to the previous batch to this batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it still can't be added to the batch, the message is probably too big to fit in a batch
                    throw new Error("Message too big to fit in a batch");
                }
            }
        }

        // Send the last created batch of messages to the queue
        await sender.sendMessages(batch);

        console.log(`Sent a batch of messages to the queue: ${queueName}`);

        // Close the sender
        await sender.close();
    } finally {
        await sbClient.close();
    }
}

// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
    });

Replace <SERVICE-BUS-NAMESPACE> with your Service Bus namespace.
Replace <QUEUE NAME> with the name of the queue.
To run the code in this file, use this command at a command prompt:
```
node send.js
```
You should see the following output.
```
Sent a batch of messages to the queue: myqueue
```

Connection string

Open a text editor, such as Visual Studio Code.

Create a file called send.js and paste the following code into it. This code sends the names of scientists as messages to your queue.

const { ServiceBusClient } = require("@azure/service-bus");

// connection string to your Service Bus namespace
const connectionString = "<CONNECTION STRING TO SERVICE BUS NAMESPACE>"

// name of the queue
const queueName = "<QUEUE NAME>"

const messages = [
    { body: "Albert Einstein" },
    { body: "Werner Heisenberg" },
    { body: "Marie Curie" },
    { body: "Steven Hawking" },
    { body: "Isaac Newton" },
    { body: "Niels Bohr" },
    { body: "Michael Faraday" },
    { body: "Galileo Galilei" },
    { body: "Johannes Kepler" },
    { body: "Nikolaus Kopernikus" }
 ];

async function main() {
    // create a Service Bus client using the connection string to the Service Bus namespace
    const sbClient = new ServiceBusClient(connectionString);

    // createSender() can also be used to create a sender for a topic.
    const sender = sbClient.createSender(queueName);

    try {
        // Tries to send all messages in a single batch.
        // Will fail if the messages cannot fit in a batch.
        // await sender.sendMessages(messages);

        // create a batch object
        let batch = await sender.createMessageBatch();
        for (let i = 0; i < messages.length; i++) {
            // for each message in the array

            // try to add the message to the batch
            if (!batch.tryAddMessage(messages[i])) {
                // if it fails to add the message to the current batch
                // send the current batch as it is full
                await sender.sendMessages(batch);

                // then, create a new batch
                batch = await sender.createMessageBatch();

                // now, add the message failed to be added to the previous batch to this batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it still can't be added to the batch, the message is probably too big to fit in a batch
                    throw new Error("Message too big to fit in a batch");
                }
            }
        }

        // Send the last created batch of messages to the queue
        await sender.sendMessages(batch);

        console.log(`Sent a batch of messages to the queue: ${queueName}`);

        // Close the sender
        await sender.close();
    } finally {
        await sbClient.close();
    }
}

// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

Replace <CONNECTION STRING TO SERVICE BUS NAMESPACE> with the connection string to your Service Bus namespace.
Replace <QUEUE NAME> with the name of the queue.
To run the code in this file, use this command at a command prompt:
```
node send.js
```
You should see the following output.
```
Sent a batch of messages to the queue: myqueue
```

Receive messages from a queue

Passwordless

Sign in with the Azure CLI command az login for your local machine to provide the passwordless authentication required in this code.

Open a text editor, such as Visual Studio Code.

Create a file called receive.js and paste the following code into it.

const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

 async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createReceiver() can also be used to create a receiver for a subscription.
    const receiver = sbClient.createReceiver(queueName);

    // function to handle messages
    const myMessageHandler = async (messageReceived) => {
        console.log(`Received message: ${messageReceived.body}`);
    };

    // function to handle any errors
    const myErrorHandler = async (error) => {
        console.log(error);
    };

    // subscribe and specify the message and error handlers
    receiver.subscribe({
        processMessage: myMessageHandler,
        processError: myErrorHandler
    });

    // Waiting long enough before closing the sender to send messages
    await delay(20000);

    await receiver.close();
    await sbClient.close();
}
// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

Replace <SERVICE-BUS-NAMESPACE> with your Service Bus namespace.
Replace <QUEUE NAME> with the name of the queue.
To run the code in this file, use this command at a command prompt:
```
node receive.js
```

Connection string

Open your favorite editor, such as Visual Studio Code.

Create a file called receive.js and paste the following code into it.

const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");

// connection string to your Service Bus namespace
const connectionString = "<CONNECTION STRING TO SERVICE BUS NAMESPACE>"

// name of the queue
const queueName = "<QUEUE NAME>"

 async function main() {
    // create a Service Bus client using the connection string to the Service Bus namespace
    const sbClient = new ServiceBusClient(connectionString);

    // createReceiver() can also be used to create a receiver for a subscription.
    const receiver = sbClient.createReceiver(queueName);

    // function to handle messages
    const myMessageHandler = async (messageReceived) => {
        console.log(`Received message: ${messageReceived.body}`);
    };

    // function to handle any errors
    const myErrorHandler = async (error) => {
        console.log(error);
    };

    // subscribe and specify the message and error handlers
    receiver.subscribe({
        processMessage: myMessageHandler,
        processError: myErrorHandler
    });

    // Waiting long enough before closing the sender to send messages
    await delay(20000);

    await receiver.close();
    await sbClient.close();
}
// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

Replace <CONNECTION STRING TO SERVICE BUS NAMESPACE> with the connection string to your Service Bus namespace.
Replace <QUEUE NAME> with the name of the queue.
To run the code in this file, use this command at a command prompt:
```
node receive.js
```

You should see the following output.

Received message: Albert Einstein
Received message: Werner Heisenberg
Received message: Marie Curie
Received message: Steven Hawking
Received message: Isaac Newton
Received message: Niels Bohr
Received message: Michael Faraday
Received message: Galileo Galilei
Received message: Johannes Kepler
Received message: Nikolaus Kopernikus

On the Overview page for the Service Bus namespace in the Azure portal, you can see incoming and outgoing message count. You might need to wait for a minute or so and then refresh the page to see the latest values.

:::image type="content" source="./media/service-bus-java-how-to-use-queues/overview-incoming-outgoing-messages.png" alt-text="Screenshot shows iIncoming and outgoing message count." lightbox="./media/service-bus-java-how-to-use-queues/overview-incoming-outgoing-messages.png":::

Select the queue on this Overview page to navigate to the Service Bus Queue page. You see the incoming and outgoing message count on this page too. You also see other information such as the current size of the queue, maximum size, active message count, and so on.

:::image type="content" source="./media/service-bus-java-how-to-use-queues/queue-details.png" alt-text="Screenshot shows Queue detail information." lightbox="./media/service-bus-java-how-to-use-queues/queue-details.png":::

Troubleshooting

If you receive one of the following errors when you run the passwordless version of the JavaScript code, sign in by using the Azure CLI command, az login. The appropriate role is applied to your Azure user account:

'Send' claims are required to perform this operation
'Receive' claims are required to perform this operation

Clean up resources

Navigate to your Service Bus namespace in the Azure portal, and select Delete on the Azure portal to delete the namespace and the queue in it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quickstart: Send messages to and receive messages from Azure Service Bus queues (JavaScript)

Prerequisites

Passwordless

Connection string

Use Node Package Manager (NPM) to install the package

Passwordless

Connection string

Send messages to a queue

Passwordless

Connection string

Receive messages from a queue

Passwordless

Connection string

Troubleshooting

Clean up resources

Related content

FilesExpand file tree

service-bus-nodejs-how-to-use-queues.md

Latest commit

History

service-bus-nodejs-how-to-use-queues.md

File metadata and controls

Quickstart: Send messages to and receive messages from Azure Service Bus queues (JavaScript)

Prerequisites

Use Node Package Manager (NPM) to install the package

Send messages to a queue

Receive messages from a queue

Troubleshooting

Clean up resources

Related content