ビジネスイベントおよび Azure Service Bus

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

この記事では、Microsoft Azure Service Bus エンドポイントを構成する方法と、Service Bus からビジネスイベントを消費する方法を説明します。

シナリオの概要

セキュリティのベストプラクティスでは、接続文字列をアプリケーション外の Azure Key Vault ドライブに保存し、アプリケーションに対して Key Vault キー、シークレット、証明書の適切なアクセス権を付与することをお勧めします。

このアプローチの多くの利点のうち 2 つを次に示します。

アプリケーションデータベースにアクセスできるユーザーは、サードパーティの接続文字列を取得できません。
特に複数のアプリケーションが同じリソースにアクセスする場合、更新する必要がある接続文字列が 1 か所だけなのでメンテナンスが簡単です。

完了する必要がある手順の概要を次に示します。

新しい Service Bus の名前空間を作成します。
新しい Service Bus の記事とサブスクリプションを作成します。
Service Bus キーを格納する新しい Key Vault を作成します。
Key Vault にアクセスするためのアクセス許可が与えられている Azure アプリを登録します。
ビジネスイベントエンドポイントをコンフィギュレーションします。
ビジネスイベントを消費します。

新しい Service Bus の名前空間を作成する

Azure ポータルにサインインします。
すべてのサービス > 統合 > Service Bus を順に選択します。
追加を選択して新しい Service Bus の名前空間を作成し、パラメーターを設定します。標準の価格レベルを選択します。ラボのコンテナーとして新しいリソースグループを作成するか、または既存のリソースグループを使用できます。

メモ

基本価格レベルを選択した場合、作成できるのはキューのみです。トピックを作成するには標準価格帯を選択する必要があります。
すべてのパラメーターの設定が終了したら作成を選択します。

新しい Service Bus の記事とサブスクリプションを作成する

Azure ポータルで、作成した Service Bus を選択して新しい記事を作成します。
新しい記事を選択して、BE-USMF という名前の新しいサブスクリプションを作成します。
Service Bus のブレードに戻り、イベントを送信する新しい共有アクセスポリシーを作成します。 Service Bus の記事にイベントを送信するには送信ポリシーのみが必要です。
新しい送信ポリシーを選択して プライマリ接続文字列 値をコピーして保存します。この値は後で使用します。

メモ

共有アクセスポリシーは、記事レベルではなく、名前空間レベルにある必要があります。記事レベルの共有アクセスポリシーを使用する場合は、ビジネスイベント用のエンドポイントをコンフィギュレーションするときに、末尾にセミコロン EntityPath= を付加した文字列を含めることはできません。

新しい Key Vault の作成

この手順では、前の手順でコピーしたキーを保存する Key Vault を作成します。 Key Vault は、キー、シークレット、証明書を保存するために使用する安全なドライブです。接続文字列を保存する代わりに、より一般的で安全なアプローチは Key Vault に保存することです。その後、新しいアプリケーションを Microsoft Entra に登録し、Key Vault からシークレットを取得する権限を付与できます。

Azure ポータルで すべてのサービス > セキュリティ > Key Vaults を選択します。
リソースグループに新しい Key Vault を作成し、デフォルトのパラメーターを設定します。
概要を選択し、Key Vault の DNS 名 値をコピーして保存します。この値は後で使用します。
BE-Key Vault > シークレット > 生成/インポート を選択します。シークレットの名前を入力し、先に保存した Service Bus 接続文字列を貼り付けます。
作成を選択します。

新しいアプリケーションの登録

この手順では、新しいアプリケーションを Microsoft Entra ID に登録して、Key Vault のシークレットの読み取りと取得アクセスを許可します。次に財務と運用はこのアプリケーションを使用してサービスバスシークレットを取得します。

Azure ポータルですべてのサービス > セキュリティ > Microsoft Entra ID を選択します。
アプリ登録 (プレビュー) > 新しい登録 を選択し、アプリケーションの名前を入力します。
登録を選択します。
新しいアプリケーションを選択してから 証明書とシークレット > 新しいクライアントシークレット を選択します。シークレットの名前を入力し、有効期限が切れないようにシークレットを設定します。その後追加を選択します。
新しいシークレットをコピーして保存します。これは後で使用します。

重要

シークレットは一度だけ表示されます。シークレットをコピーし忘れた場合は、削除してから新しいシークレットを作成する必要があります。
概要を選択し、アプリケーション ID をコピーして保存します。この値は後で使用します。
すべてのサービス > セキュリティ > Key Vaults を選択します。
前に作成した Key Vault を選択してから アクセスポリシー > 新規追加 を選択します。
プリンシパル ブレードで、新しい登録済みアプリケーションを選択します。 Key Vault のシークレットを取得するには、Get と List シークレットアクセス許可のチェックボックスを選択します。
新しいアクセスポリシーを保存します。

ビジネスイベントエンドポイントのをコンフィギュレーション

アプリケーションにサインインし、システム管理>設定>ビジネスイベントの順に移動します。
エンドポイント を選択します。
新規を選択します。
Azure Service Bus のトピック を選択します。
次へを選択します。
必要なパラメーター値を設定します。
OKを選択します。

ビジネスイベントの消費

ビジネスシナリオは USMF 企業の顧客の支払いが転記されるたびに、電子メールやメッセージをチームチャネルに送信します。顧客アカウント番号、顧客名、支払い額などの詳細がメッセージ`に含まれる必要があります。

ビジネスイベントカタログを選択し、顧客の支払が転記されましたビジネスイベントを探します
USMF 会社のビジネスイベントを有効化します。

新しい Service Bus エンドポイントを使用するビジネスイベントを有効化した後、アプリケーションはテストメッセージを送信してコンフィギュレーションが正確であることを確認し、接続をキャッシュします。
テストメッセージが受信されたことを確認するには Azure ポータルで BE-Topic Service Bus 記事を選択して、以前に作成した BE-USMF Service Bus サブスクリプションに入ります。サブスクリプションのメッセージ数が少なくとも 1 の値を示していることを確認します。そうでない場合は、バッチジョブがメッセージを受信するまで待ちます。
すべてのサービス > 統合 > Logic Apps を順に選択します。
リソースグループに新しいロジックアプリを作成します。
Logic Apps リソースを作成したら、空のロジックアプリを作成するオプションを選択します。
サービスバス を検索して選択します。
記事サブスクリプションでメッセージを受信した場合 (オートコンプリート) という名前のトリガーを選択します。

メモ

オートコンプリートとは、メッセージが取得された後にサブスクリプションキューから削除されることを意味します。ピークロックは同時実行消費者を許可します。メッセージを削除するには、Service Bus アプリケーションプログラミングインターフェイス (API) の完了コマンドを呼び出す必要があります。

Logic Apps は初めて Service Bus にアクセスするために新しい接続を要求します。この接続は、接続の詳細を Service Bus 名前空間の URL と資格情報としてキャッシュします。
Service Bus 名前空間を選択して新しい接続の名前を入力します。
ロジックアプリの RootManageSharedAccessKey ポリシーを選択して作成を選択します。

メモ

メッセージを送信するのではなく取得する必要があるため送信ポリシーをここで使用できません。ベストプラクティスとして、このユースケースに新しいポリシーを作成して リッスン アクセス許可のみを付与できます。
トリガーパラメーターを選択します。作成した記事とサブスクリプションに必ず正しい名前を使用します。

この API はコンフィギュレーション可能な頻度で、新しいメッセージの Service Bus をポーリングします (既定は 3 分ごと)。 Logic Apps はトリガーの呼び出しとアクションの実行ごとに課金されるため、メッセージの量が少ない場合に API は不要なトリガーのコストに影響を与えます。ただし、途中で Azure Event Grid を使用するプッシュアーキテクチャを実装できます。キューやサブスクリプションにメッセージがある場合、Service Bus はイベントをイベントグリッドにプッシュできます。詳細については Azure Service Bus からイベントグリッドへの統合の概要を参照してください。
新規ステップ を選択して新しいアクションを追加します。
JSON の解析 データ処理を検索します。このステップは、データコントラクトのスキーマを使用してメッセージを解析するために必要です。

Service Bus から受信した本文コンテンツは base64 形式にエンコードされます。したがって、JavaScript Object Notation (JSON) ペイロードを解析する前に文字列形式に変換する必要があります。
コンテンツ フィールドをクリックし、表示されたウィンドウの式タブに次の式を入力します: Base64ToString()
式の括弧の間にカーソルを置き、動的コンテンツ タブで前の Service Bus トリガーから メッセージのコンテンツ コンテンツを見つけて選択します。その後、OK を選択します。

次に、アプリケーションから受け取った契約のスキーマを入力する必要があります。アプリケーションでは、サンプルペイロードのみ提供します。ただし、Azure Logic Apps の機能を使用してペイロードからスキーマを生成できます。
ビジネスイベントカタログのイベントを選択し、スキーマのダウンロードリンクを選択します。ダウンロードしたテキストファイルを開いて内容をコピーします。
Logic Apps に戻って サンプルペイロードを使用してスキーマを生成 リンクを選択します。テキストファイルの内容を貼り付けて完了を選択します。
サンプルペイロードの品質により、特に実値がサンプルペイロードで整数として与えられた場合、ジェネレーターは整数と実値を区別しません。生成されたスキーマを確認して整数データ型のフィールドを数値データ型に変更する必要があるか判断します。 (JSON で数値データ型は実値を表します。)

次に、顧客の支払いの詳細を含む通知電子メールの送信など、最終的なアクションを選択します。
電子メールの送信 アクションを検索し、自分の Microsoft 365 アカウントにサインインします。
メッセージの本文および、必須項目を入力します。
ロジックアプリを保存します。
顧客の支払いを転記して、ビジネスイベントをトリガーします。そして、ロジックアプリが実行されていること、顧客の支払いの詳細が記載された電子メールを受信することを確認します。