Event Hubs の接続文字列の取得

  • [アーティクル]

名前空間内のイベント ハブと通信を行うには、名前空間またはイベント ハブの接続文字列が必要となります。 アプリケーションから名前空間の接続文字列を使用した場合、そのアプリケーションには、該当する名前空間内のすべてのイベント ハブに対するアクセス権 (管理、読み取り、または書き込み) が与えられます。 イベント ハブへの接続文字列を使用すると、その特定のイベント ハブへのアクセス権が提供されます。

名前空間の接続文字列には、次のコンポーネントが埋め込まれています。

  • 作成した Event Hubs 名前空間の完全修飾ドメイン名 (Event Hubs 名前空間の名前に続けて servicebus.windows.net が含まれます)
  • 共有アクセス キーの名前
  • 共有アクセス キーの値

実際の名前空間の接続文字列の例を次に示します。

Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>

イベント ハブの接続文字列は、追加のコンポーネントを含んでいます。 EntityPath=<EventHubName> です。

Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>;EntityPath=<EventHubName>

この記事では、Azure portal、PowerShell、CLI を使用して、名前空間の接続文字列または特定のイベント ハブの接続文字列を取得する方法について説明します。

Azure portal

名前空間の接続文字列

  1. Azure ポータルにサインインします。

  2. 左のナビゲーション メニューから、 [すべてのサービス] を選択します。

  3. [分析] セクションで [Event Hubs] を選択します。

  4. イベント ハブの一覧で、自分のイベント ハブを選択します。

  5. [Event Hubs 名前空間] ページで、左側のメニューの [共有アクセス ポリシー] を選択します。

  6. ポリシーの一覧で共有アクセス ポリシーを選択します。 既定のポリシーの名前は RootManageSharedAccessPolicy です。 適切なアクセス許可 (送信、リッスン) を持つポリシーを追加し、そのポリシーを使用できます。

    Event Hubs の共有アクセス ポリシー

  7. [接続文字列 - 主キー] フィールドの隣にあるコピー ボタンを選択します。

    Event Hubs - 接続文字列の取得

名前空間内の特定のイベント ハブの接続文字列

このセクションでは、名前空間内の特定のイベント ハブの接続文字列を取得する手順について説明します。

  1. [Event Hubs 名前空間] ページの一番下のペインからイベント ハブを選択します。

  2. [Event Hubs のインスタンス] ページで、左側のメニューの [共有アクセス ポリシー] を選択します。

  3. イベント ハブに対して作成される既定のポリシーはありません。 [管理]、[送信]、または [リッスン] のアクセス権を含んだポリシーを作成します。

  4. 一覧からポリシーを選択します。

  5. [接続文字列 - 主キー] フィールドの隣にあるコピー ボタンを選択します。

    特定のイベント ハブへの接続文字列。

Azure PowerShell

Get-AzEventHubKey を使用して、特定のポリシーまたはルール名の接続文字列を取得することができます。

次に示したのは、名前空間の接続文字列を取得するためのサンプル コマンドです。 MyAuthRuleName は、共有アクセス ポリシーの名前です。 名前空間の既定値は RootManageSharedAccessKey です。

Get-AzEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AuthorizationRuleName MyAuthRuleName

次に示したのは、名前空間内の特定のイベント ハブの接続文字列を取得するためのサンプル コマンドです。

Get-AzEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName

次に示したのは、エイリアスを持つ Geo-DR クラスター内のイベント ハブの接続文字列を取得するためのサンプル コマンドです。

Get-AzEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AliasName MyAliasName -Name MyAuthRuleName

Azure CLI

次に示したのは、名前空間の接続文字列を取得するためのサンプル コマンドです。 MyAuthRuleName は、共有アクセス ポリシーの名前です。 名前空間の既定値は RootManageSharedAccessKey です。

az eventhubs namespace authorization-rule keys list --resource-group MyResourceGroupName --namespace-name MyNamespaceName --name RootManageSharedAccessKey

次に示したのは、名前空間内の特定のイベント ハブの接続文字列を取得するためのサンプル コマンドです。

az eventhubs eventhub authorization-rule keys list --resource-group MyResourceGroupName --namespace-name MyNamespaceName --eventhub-name MyEventHubName --name MyAuthRuleName

次に示したのは、エイリアスを持つ Geo-DR クラスター内のイベント ハブの接続文字列を取得するためのサンプル コマンドです。

az eventhubs georecovery-alias authorization-rule keys list --resource-group MyResourceGroupName --namespace-name MyNamespaceName --eventhub-name MyEventHubName --alias-name MyAliasName --name MyAuthRuleName

Event Hubs 用の Azure CLI コマンドについて詳しくは、Event Hubs 用の Azure CLI に関する記事をご覧ください。

次のステップ

Event Hubs の詳細については、次のリンク先を参照してください: