# @eswarpr/node-red-azure-service-bus

> A set of Node-RED nodes for sending and receiving messages from Azure Service Bus topics and queues

Latest version **1.0.11** (published 2022-12-30) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @eswarpr/node-red-azure-service-bus
pnpm add @eswarpr/node-red-azure-service-bus
yarn add @eswarpr/node-red-azure-service-bus
bun add @eswarpr/node-red-azure-service-bus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2022-12-30 |
| First published | 2022-12-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.16.0 <=18.12.0 |
| Dependencies | 1 |
| Unpacked size | 35.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Eswar Prakash |
| Maintainers | eswarpr |
| Keywords | node-red, azure, service bus, topic |

## Links

- npm: https://www.npmjs.com/package/@eswarpr/node-red-azure-service-bus
- Repository: https://github.com/eswarpr/node-red-contrib-azure-service-bus
- Homepage: https://github.com/eswarpr/node-red-contrib-azure-service-bus#readme
- Issues: https://github.com/eswarpr/node-red-contrib-azure-service-bus/issues
- npm.io page: https://npm.io/package/@eswarpr/node-red-azure-service-bus

## Dependencies (1)

- [@azure/service-bus](https://npm.io/package/@azure/service-bus.md) ^7.7.3

## Recent versions

- 1.0.11 (latest) — 2022-12-30
- 1.0.10 — 2022-12-29
- 1.0.7 — 2022-12-29
- 1.0.6 — 2022-12-29
- 1.0.5 — 2022-12-29
- 1.0.4 — 2022-12-29

## README

# @eswarpr/node-red-azure-service-bus

A set of [Node-RED](https://nodered.org) nodes to send and receive [Azure Service Bus](https://azure.microsoft.com/en-gb/products/service-bus/)
messages. You will need access to a valid [Microsoft Azure](https://azure.microsoft.com/en-gb/) subscription and Azure Service Bus
deployed in it to use this node.

# Install

Either use the Node-RED Menu -> Manage Palette option to install, or run the following command in your Node-RED user directory - 
typically ``~/.node-red``

``
npm i @eswarpr/node-red-azure-service-bus
``

# Usage
**Note:** Please ensure that you have a valid Azure Service Bus subscription at hand
before using this node.

## Azure Service Bus - Receive Topic Message
Generates a ``msg.payload`` set to the body of the message received
from service bus topic to a subscription.

### Outputs
- ``msg.topic`` - _string_ - the service bus topic that was the source of the message
- ``msg.payload`` - _any_ - the contents of the message that was received from service bus
- ``msg.message`` - _object (see below)_ - additional information about the message

The ``msg.message`` will be set to an object containing the following additional data:
- ``contentType`` - _string_ - the MIME type of the received message, as specified at the source.
- ``id`` - _string_ - the unique ID of the message as specified at the source.
- ``subject`` - _string_ - the subject of the message as specified at the source.
- ``properties`` - _object_ - additional message metadata specified at the source.

## Azure Service Bus - Receive Queue Message
Generates a ``msg.payload`` set to the body of the message received
from a service bus queue.

### Outputs
- ``msg.topic`` - _string_ - the service bus queue that was the source of the message
- ``msg.payload`` - _any_ - the contents of the message that was received from service bus
- ``msg.message`` - _object (see below)_ - additional information about the message

The ``msg.message`` will be set to an object containing the following additional data:
- ``contentType`` - _string_ - the MIME type of the received message, as specified at the source.
- ``id`` - _string_ - the unique ID of the message as specified at the source.
- ``subject`` - _string_ - the subject of the message as specified at the source.
- ``properties`` - _object_ - additional message metadata specified at the source.

## Azure Service Bus - Send Topic Message
Generates and sends a service bus message to the topic specified in the configuration of the node.

### Input
- ``msg.payload`` - _any_ - the message to send
- ``msg.message`` - _object (see below)_ - additional information about the message

The ``msg.message`` property can be setup with the following additional information, which will
passed without changes to service bus as a part of the sent message:
- ``contentType`` - _string_ - the MIME type of the message contents
- ``properties`` - _object_ - additional metadata for the message

## Azure Service Bus - Send Queue Message
Generates and sends a service bus message to the queue specified in the configuration of the node.

### Input
- ``msg.payload`` - _any_ - the message to send
- ``msg.message`` - _object (see below)_ - additional information about the message

The ``msg.message`` property can be setup with the following additional information, which will
passed without changes to service bus as a part of the sent message:
- ``contentType`` - _string_ - the MIME type of the message contents
- ``properties`` - _object_ - additional metadata for the message

---
_Source: https://npm.io/package/@eswarpr/node-red-azure-service-bus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._