Azure Service Bus キューとの間でメッセージを送受信する (JavaScript)

[アーティクル]
12/08/2023

このチュートリアルでは、次の手順を実行します。

Azure Portal を使用して Service Bus 名前空間を作成する。
Azure Portal を使用して Service Bus キューを作成する。
次のことを行うための JavaScript アプリケーションを @azure/service-bus パッケージを使って作成する。
1. メッセージのセットをキューに送信する。
2. キューからそれらのメッセージを受信する。

Note

このクイックスタートでは、メッセージを Service Bus キューに送信し、それらを受信するという簡単なシナリオでのステップバイステップの手順を説明します。 Azure Service Bus の事前構築済みの JavaScript および TypeScript サンプルが、GitHub の Azure SDK for JavaScript リポジトリに用意されています。

前提条件

このサービスを初めて使用する場合は、このクイックスタートを実行する前に、[Service Bus の概要](service-bus-messaging-overview.md)に関する記事を参照してください。

Azure サブスクリプション。このチュートリアルを完了するには、Azure アカウントが必要です。 MSDN のサブスクライバー特典を有効にするか、無料アカウントにサインアップしてください。
Node.js LTS

パスワードレス
接続文字列

自分の Azure アカウントでこのクイックスタートを行うには、次のものが必要です。

開発者マシンにパスワードレス認証を提供する Azure CLI をインストールします。
ターミナルまたはコマンドプロンプトで、az login を使って Azure アカウントでサインインします。
リソースに適切なデータロールを追加するときは、同じアカウントを使います。
同じターミナルまたはコマンドプロンプトでコードを実行します。
Service Bus 名前空間のキューの名前を記録しておきます。コードでそれが必要になります。

Note

このチュートリアルでは、コピーして Nodejs を使用して実行できるサンプルを扱います。 Node.js アプリケーションを作成する手順については、Node.js アプリケーションの作成と Azure Web サイトへのデプロイ、またはWindows PowerShell を使用する Node.js クラウドサービスに関するページをご覧ください。

Azure Portal での名前空間の作成

Azure の Service Bus メッセージングエンティティを使用するには、Azure 全体で一意となる名前を備えた名前空間を最初に作成しておく必要があります。名前空間により、ご利用のアプリケーション内に Service Bus リソース (キュー、トピックなど) 用のスコープコンテナーが提供されます。

名前空間を作成するには:

Azure portal にサインインします。
[すべてのサービス] ページに移動します。
左側のナビゲーションバーで、カテゴリの一覧から [統合] を選択し、[Service Bus] 上にマウスポインターを置き、[Service Bus] タイルの [+] ボタンを選択します。
[名前空間の作成] ページの [基本] タブで、こちらの手順を実行します。
1. [サブスクリプション] で、名前空間を作成する Azure サブスクリプションを選択します。
2. [リソースグループ] で、名前空間を追加する既存のリソースグループを選択するか、新しいリソースグループを作成します。
3. 名前空間の名前を入力します。名前空間名は次の名前付け規則に従う必要があります。
  - この名前は Azure 全体で一意である必要があります。その名前が使用できるかどうかがすぐに自動で確認されます。
  - 名前の長さは 6 ～ 50 文字である。
  - この名前には、文字、数字、ハイフン "-" のみを含めることができます。
  - 名前の先頭は文字、末尾は文字または数字にする必要があります。
  - 名前の末尾は “-sb“ または “-mgmt“ にはできません。
4. [場所] で、名前空間をホストするリージョンを選択します。
5. [価格レベル] で、名前空間の価格レベル (Basic、Standard、Premium) を選択します。このクイックスタートでは、 [Standard] を選択します。
  
  重要
  
  トピックとサブスクリプションを使用する場合は、Standard または Premium を選択してください。 Basic 価格レベルでは、トピックとサブスクリプションはサポートされていません。
  
  [Premium] 価格レベルを選択した場合は、メッセージングユニットの数を指定します。 Premium レベルでは、各ワークロードが分離した状態で実行されるように、CPU とメモリのレベルでリソースが分離されます。このリソースのコンテナーをメッセージングユニットと呼びます。 Premium 名前空間には、少なくとも 1 つのメッセージングユニットがあります。 Service Bus の Premium 名前空間ごとに、1 個、2 個、4 個、8 個、または 16 個のメッセージングユニットを選択できます。詳細については、Service Bus の Premium メッセージングに関するページをご覧ください。
6. ページ下部にある [確認と作成] を選択します。
7. [確認および作成] ページで、設定を確認し、 [作成] を選択します。
リソースのデプロイが成功したら、デプロイページで [リソースに移動] を選択します。
Service Bus 名前空間のホームページが表示されます。

Azure portal でキューを作成する

[Service Bus 名前空間] ページで、左側のナビゲーションメニューの [キュー] を選択します。
[キュー] ページで、ツールバーの [+ キュー] を選択します。
キューの名前を入力し、他の値は既定値のままにします。
ここで、 [作成] を選択します。

Azure に対してアプリを認証する

このクイックスタートでは、Azure Service Bus に接続する 2 つの方法である、パスワードレスと接続文字列について説明します。

最初のオプションでは、Microsoft Entra ID とロールベースのアクセス制御 (RBAC) でセキュリティプリンシパルを使用して Service Bus 名前空間に接続する方法を示します。コードや構成ファイル、または Azure Key Vault などのセキュリティで保護されたストレージに、ハードコーディングされた接続文字列を含める心配はありません。

2 番目のオプションでは、接続文字列を使用して Service Bus 名前空間に接続する方法を示します。 Azure を初めて使用する場合は、接続文字列オプションの方が理解しやすいかもしれません。実際のアプリケーションと運用環境では、パスワードレスオプションを使用することをお勧めします。詳細については、「認証と承認」を参照してください。パスワードレス認証の詳細については、概要ページを参照してください。

パスワードレス (推奨)
接続文字列

Microsoft Entra ユーザーにロールを割り当てる

ローカルでの開発時には、Azure Service Bus に接続するユーザーアカウントに正しいアクセス許可があることを確認してください。メッセージを送受信するには、Azure Service Bus データ所有者ロールが必要です。このロールを自分に割り当てるには、ユーザーアクセス管理者ロール、または Microsoft.Authorization/roleAssignments/write アクションを含む別のロールが必要です。 Azure portal、Azure CLI、または Azure PowerShell を使用して、ユーザーに Azure RBAC ロールを割り当てることができます。ロールの割り当てに使用できるスコープの詳細は、スコープの概要ページを参照してください。

次の例では、ユーザーアカウントに、Azure Service Bus Data Owner ロールを割り当てます。これにより、Azure Service Bus リソースへのフルアクセスが提供されます。実際のシナリオでは、より安全な運用環境を実現するため、最小限の特権の原則に従って、必要な最小限のアクセス許可のみをユーザーに付与します。

Azure Service Bus 用の Azure 組み込みロール

Azure Service Bus の場合、名前空間およびそれに関連するすべてのリソースの Azure portal および Azure リソース管理 API による管理は、Azure RBAC モデルを使って既に保護されています。 Azure では、Service Bus 名前空間へのアクセスを承認するための次の Azure 組み込みロールが提供されています。

Azure Service Bus データ所有者:Service Bus 名前空間とそのエンティティ (キュー、トピック、サブスクリプション、およびフィルター) へのデータアクセスが可能です。このロールのメンバーは、キューまたはトピックやサブスクリプションとの間でメッセージを送受信できます。
Azure Service Bus データ送信者: このロールを使用して、Service Bus 名前空間とそのエンティティへの送信アクセスを許可します。
Azure Service Bus データ受信者: このロールを使用して、Service Bus 名前空間とそのエンティティへの受信アクセスを許可します。

カスタムロールを作成する場合は、Service Bus 操作に必要な権限に関するページを参照してください。

Microsoft Entra ユーザーを Azure Service Bus 所有者ロールに追加する

Microsoft Entra ユーザー名を、Service Bus 名前空間レベルの Azure Service Bus データ所有者ロールに追加します。これにより、ユーザーアカウントのコンテキストで実行されているアプリがキューまたはトピックにメッセージを送信し、キューまたはトピックのサブスクリプションからメッセージを受信できるようになります。

重要

ほとんどの場合、ロールの割り当てが Azure に反映されるまでの時間は 1、2 分です。まれに、最大 8 分かかる場合があります。初めてコードを実行したときに認証エラーを受け取る場合は、しばらく待ってから再試行してください。

Azure portal で Service Bus 名前空間ページが開いていない場合は、メイン検索バーまたは左側のナビゲーションを使用して Service Bus 名前空間を見つけます。
概要ページで、左側のメニューから [アクセス制御 (IAM)] を選択します。
[アクセス制御 (IAM)] ページで、[ロールの割り当て] タブを選びます。
上部のメニューから [+ 追加] を選択し、次に結果のドロップダウンメニューから [ロールの割り当ての追加] を選択します。
検索ボックスを使って、結果を目的のロールに絞り込みます。この例では、Azure Service Bus Data Owner を検索して一致する結果を選択します。 [次へ] を選びます。
[アクセスの割り当て先] で、[ユーザー、グループ、またはサービスプリンシパル] を選び、[+ メンバーの選択] を選びます。
ダイアログで、自分の Microsoft Entra ユーザー名 (通常は user@domain メールアドレス) を検索し、ダイアログの下部にある [選択] を選びます。
[レビューと割り当て] を選んで最終ページに移動し、もう一度 [レビューと割り当て] を行ってプロセスを完了します。

Service Bus の必要な npm パッケージをインストールするには、パスに npm を設定したコマンドプロンプトを開き、サンプルを格納するフォルダーにディレクトリを変更してから、このコマンドを実行します。
次のパッケージをインストールします。
```
npm install @azure/service-bus @azure/identity
```

Service Bus の必要な npm パッケージをインストールするには、パスに npm を設定したコマンドプロンプトを開き、サンプルを格納するフォルダーにディレクトリを変更してから、このコマンドを実行します。
次のパッケージをインストールします。
```
npm install @azure/service-bus
```

メッセージをキューに送信する

次のサンプルコードは、キューにメッセージを送信する方法を示しています。

パスワードレス
接続文字列

このコードで必要なパスワードレス認証をローカルコンピューターで提供するには、Azure CLI の az login でサインインしている必要があります。

Visual Studio Code など、お好みのエディターを開きます。

send.js というファイルを作成し、そこに以下のコードを貼り付けます。このコードは、科学者の名前をメッセージとしてキューに送信します。

重要

パスワードレスの資格情報は、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);
    });

<SERVICE-BUS-NAMESPACE> は、Service Bus 名前空間に置き換えます。
<QUEUE NAME> をキューの名前に置き換えます。
その後、コマンドプロンプトで次のコマンドを実行して、このファイルを実行します。
```
node send.js
```

次の出力が表示されます。

Sent a batch of messages to the queue: myqueue

Visual Studio Code など、お好みのエディターを開きます。

send.js というファイルを作成し、そこに以下のコードを貼り付けます。このコードは、科学者の名前をメッセージとしてキューに送信します。

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);
 });

<CONNECTION STRING TO SERVICE BUS NAMESPACE> を Service Bus 名前空間の接続文字列に置き換えます。
<QUEUE NAME> をキューの名前に置き換えます。
その後、コマンドプロンプトで次のコマンドを実行して、このファイルを実行します。
```
node send.js
```

次の出力が表示されます。

Sent a batch of messages to the queue: myqueue

キューからメッセージを受信する

パスワードレス
接続文字列

このコードで必要なパスワードレス認証をローカルコンピューターで提供するには、Azure CLI の az login でサインインしている必要があります。

Visual Studio Code など、お好みのエディターを開きます

receive.js というファイルを作成し、そこに次のコードを貼り付けます。

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);
 });

<SERVICE-BUS-NAMESPACE> は、Service Bus 名前空間に置き換えます。
<QUEUE NAME> をキューの名前に置き換えます。
その後、コマンドプロンプトで次のコマンドを実行して、このファイルを実行します。
```
node receive.js
```

Visual Studio Code など、お好みのエディターを開きます

receive.js というファイルを作成し、そこに次のコードを貼り付けます。

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);
 });

<CONNECTION STRING TO SERVICE BUS NAMESPACE> を Service Bus 名前空間の接続文字列に置き換えます。
<QUEUE NAME> をキューの名前に置き換えます。
その後、コマンドプロンプトで次のコマンドを実行して、このファイルを実行します。
```
node receive.js
```

次の出力が表示されます。

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

Azure portal の Service Bus 名前空間の [概要] ページで、受信メッセージ数と送信メッセージ数を確認できます。最新の値を表示するには、1 分程度待ってから、ページを最新の情報に更新しなければならないことがあります。

受信メッセージ数と送信メッセージ数

この [概要] ページでキューを選択して、 [Service Bus キュー] ページに移動します。このページにも、受信メッセージ数と送信メッセージ数が表示されます。加えて、キューの現在のサイズ、最大サイズ、アクティブなメッセージ数など、他の情報も表示されます。

キューの詳細

トラブルシューティング

JavaScript コードのパスワードレス バージョンを実行すると次のいずれかのエラーが発生する場合は、Azure CLI コマンド az login を使ってサインインしていること、および適切なロールが Azure ユーザーアカウントに適用されていることを確認します。

'Send' claim(s) are required to perform this operation (この操作を実行するには、'Send' クレームが必要です)
'Receive' claim(s) are required to perform this operation (この操作を実行するには、'Receive' クレームが必要です)

リソースをクリーンアップする

Azure portal で Service Bus 名前空間に移動し、Azure portal で [削除] を選択して名前空間とその中のキューを削除します。

次のステップ

次のドキュメントおよびサンプルを参照してください。

次の方法で共有

Azure Service Bus キューとの間でメッセージを送受信する (JavaScript)

前提条件

Azure Portal での名前空間の作成

Azure portal でキューを作成する

Azure に対してアプリを認証する

Microsoft Entra ユーザーにロールを割り当てる

Azure Service Bus 用の Azure 組み込みロール

Microsoft Entra ユーザーを Azure Service Bus 所有者ロールに追加する

接続文字列を取得する

ノードパッケージマネージャー (NPM) を使用してパッケージをインストールする

メッセージをキューに送信する

キューからメッセージを受信する

トラブルシューティング

リソースをクリーンアップする

次のステップ

フィードバック

その他のリソース

次の方法で共有

Azure Service Bus キューとの間でメッセージを送受信する (JavaScript)

前提条件

Azure Portal での名前空間の作成

Azure portal でキューを作成する

Azure に対してアプリを認証する

Microsoft Entra ユーザーにロールを割り当てる

Azure Service Bus 用の Azure 組み込みロール

Microsoft Entra ユーザーを Azure Service Bus 所有者ロールに追加する

ノード パッケージ マネージャー (NPM) を使用してパッケージをインストールする

メッセージをキューに送信する

キューからメッセージを受信する

トラブルシューティング

リソースをクリーンアップする

次のステップ

フィードバック

その他のリソース

ノードパッケージマネージャー (NPM) を使用してパッケージをインストールする