この記事では、サードパーティの SaaS プロバイダー ( パートナー とも呼ばれます) が Event Grid にオンボードされ、サービスからイベントを発行できるようにする方法と、それらのイベントがエンド ユーザーによってどのように使用されるかについて説明します。
Important
パートナーは、Azure Event Grid にイベントを発行し、そこからイベントを受信することもできます。 これらの機能は、 パートナー イベント 機能を通じて有効になります。 パートナー イベントに慣れていない場合は、パートナー イベントの 概要 に関するページを参照して、この記事の手順を理解し、従うために重要な重要な概念の詳細について説明します。
パートナー向けのオンボーディング プロセス
簡単に言うと、ユーザーがサービスのイベントを使用できるようにするには、通常、次のプロセスが必要です。
パートナーになることへの関心を Event Grid サービス チームに伝えます。
Event Grid リソース プロバイダー を Azure サブスクリプションに登録します。
1 つの手順で チャネル と パートナー トピック を作成します。
Important
パートナー トピックをサポートするイベント チャネル (レガシ) を作成できる場合があります。 チャネル は新しいルーティング リソースの種類であり、パートナー トピックを介したイベントの送信の両方をサポートする推奨オプションです。 イベント チャネルは従来のリソースであり、間もなく非推奨になります。
パートナー イベント機能をエンド ツー エンドでテストします。
手順 5 では、提供するユーザー エクスペリエンスの種類を決定する必要があります。 次のようなオプションがあります。
- SDKやREST APIを使用して、通常はWebグラフィカルユーザーインターフェイス(GUI)のエクスペリエンスを提供する独自のソリューションを、ドメインでホストしてください。そして、チャネル(最新および推奨)/イベントチャネル(レガシ)とそれに対応するパートナートピックを作成します。 このオプションを使用すると、パートナー トピックを作成するサブスクリプションとリソース グループをユーザーに要求できます。
- Azure portal または CLI を使用して、チャネル (推奨)/イベント チャネル (レガシ) と関連するパートナー トピックを作成します。 このオプションでは、何らかの方法でユーザーの Azure サブスクリプションを取得し、パートナー トピックを作成するリソース グループを取得する必要があります。
この記事では、Azure portal を使用して Azure Event Grid パートナーとしてオンボードする方法について説明します。
パートナーになることへの関心を伝える
パートナーになることへの関心をお伝え askgrid@microsoft.com 、Event Grid チームにお問い合わせください。 パートナー イベントのユース ケース、ペルソナ、オンボード プロセス、機能、価格などの詳細情報を提供する会話を行います。
[前提条件]
残りの手順を完了するためには、以下のものを準備してください。
Event Grid リソース プロバイダーを登録する
これまでに Event Grid を使用したことがない場合は、Event Grid リソース プロバイダーを登録する必要があります。 Event Grid を使用したことがある場合は、次のセクションに進んでください。
Azure portal で、次の手順を実行します。
左側のメニューで [サブスクリプション] を選択します。
サブスクリプションの一覧から Event Grid に使用するサブスクリプションを選択します。
[サブスクリプション] ページで、左側のメニューの [設定] の下の [リソース プロバイダー] を選択します。
Microsoft.EventGrid を検索し、[状態] が [未登録] であることを確認します。
プロバイダーの一覧で [Microsoft.EventGrid] を選択します。
コマンド バーの [登録] を選択します。
最新の情報に更新して、Microsoft.EventGrid の状態が [登録済み] に変更されたことを確認します。
パートナー登録を作成する
Azure portal にサインインします。
左側のナビゲーション ウィンドウから [すべてのサービス ] を選択し、検索バーに Event Grid パートナー登録 を入力して選択します。
[Event Grid パートナー登録] ページで、コマンド バーの [+ 作成] を選択するか、ページの [Event Grid パートナー登録の作成] リンクを選択します。
[ Create Partner Topic Type Registrations - Basics]\(パートナー トピックの種類の登録の作成 - 基本 \) ページで、次の情報を入力します。
- [ プロジェクトの詳細 ] セクションで、次の手順に従います。
- Azure サブスクリプションを選択 します。
- 既存の Azure リソース グループ を選択するか、新しいリソース グループを作成します。
- [ 登録の詳細 ] セクションで、次の手順に従います。
- [ 登録名] に、登録の名前を入力します。
- [ 組織名] に、組織の名前を入力します。
- [ パートナー リソースの種類 ] セクションで、 パートナー トピックの作成 ページに表示されるリソースの種類に関する詳細を入力します。
[パートナー リソースの種類名] に、リソースの種類の名前を入力します。
[表示名] に、パートナー トピック (リソース) の種類のわかりやすい表示名を入力します。
リソースの 種類の説明を入力します。
シナリオの 説明を入力します。 リソースのパートナー トピックを使用する方法またはシナリオについて説明する必要があります。
- [ プロジェクトの詳細 ] セクションで、次の手順に従います。
ページの下部にある [ 次へ: カスタム サービス ] を選択します。 [パートナー登録の作成] ページの [カスタマー サービス] タブで、イベント ソースに問題がある場合にサブスクライバー ユーザーがユーザーに連絡するために使用する情報を入力します。
電話番号を入力 します。
電話番号の 内線番号 を入力します。
サポート Web サイトの URL を入力します。
ページの下部にある [ 次へ: タグ ] を選択します。
[ タグ ] ページで、次の値を構成します。
- 追加するタグの 名前 と 値 を入力します。 この手順は 省略可能です。
- ページの下部にある [確認と作成 ] を選択して登録を作成します (パートナー トピックの種類)。
[ 確認と作成 ] ページで、すべての設定を確認し、[ 作成 ] を選択してパートナー登録を作成します。
パートナー名前空間を作成する
Azure portal で、左側のナビゲーション メニューから [すべてのサービス ] を選択し、検索バーに 「Event Grid Partner Namespaces 」と入力し、一覧から選択します。
[Event Grid パートナー名前空間] ページで、ツール バーの [+ 作成] を選択します。
[ パートナー名前空間の作成 - 基本] ページで、次の情報を指定します。
[ プロジェクトの詳細 ] セクションで、次の手順を実行します。
- Azure サブスクリプションを選択 します。
- 既存の リソース グループ を選択するか、リソース グループを作成します。
[ 名前空間の詳細 ] セクションで、次の手順を実行します。
名前空間の名前を入力します。
名前空間の 場所 を選択します。
パートナー トピック ルーティング モードでは、イベントのチャネル名ヘッダーまたはソース属性を選択します。
-
チャネル名ヘッダー ルーティング: この種類のルーティングでは、イベントをルーティングするチャネルの名前を指定する
aeg-channel-nameという http ヘッダーを使用してイベントを発行します。 このオプションを選択すると、名前空間に チャネル が作成されます。 -
イベント ルーティングのソース属性 。 このルーティング方法は、イベント内の
sourceコンテキスト属性の値に基づいています。 このオプションを選択すると、 イベント チャネルが作成されます。これは、 チャネル と同等のレガシであり、間もなく非推奨になります。
Important
- 名前空間が作成されると、ルーティング モードを更新することはできません。
- チャネル は新しいルーティング リソースの種類であり、推奨されるオプションです。 イベント チャネルは従来のリソースであり、間もなく非推奨になります。
-
チャネル名ヘッダー ルーティング: この種類のルーティングでは、イベントをルーティングするチャネルの名前を指定する
[ 登録の詳細 ] セクションで、次の手順に従って名前空間をパートナー登録に関連付けます。
- パートナー登録が存在する サブスクリプション を選択します。
- パートナー登録を含む リソース グループ を選択します。
- ドロップダウン リストから パートナー登録 を選択します。
ページの下部にある [ 次へ: タグ ] を選択します。
[ タグ ] ページで、タグを追加します (省略可能)。
- 追加するタグの 名前 と 値 を入力します。 この手順は 省略可能です。
- ページの下部にある [ 確認と作成 ] を選択します。
[ 確認と作成 ] ページで詳細を確認し、[ 作成] を選択します。
チャネルの作成
パートナー トピック ルーティング モードでチャネル名ヘッダーを選択した場合は、このセクションの手順に従ってチャネルを作成します。
作成したパートナー名前空間の [概要 ] ページに移動し、コマンド バーの [+ チャネル ] を選択します。
[ チャネルの作成 - 基本 ] ページで、次の手順に従います。
チャネルの 名前 を入力します。 チャネル名は、作成されるリージョン全体で一意である必要があります。
チャネルの種類として、[ パートナー トピック] を選択します。
パートナー トピックは、公開されたイベントを保持するリソースです。 後でハンドラーによって処理されるイベントを保持するパートナー トピックにイベントを転送する場合は、[パートナー トピック] を選択します。
パートナー トピックを選択した場合は、次の詳細を入力します。
パートナー トピックが作成されるサブスクリプションの ID。
パートナー トピックが作成されるリソース グループ。
パートナー トピックの名前。
パートナー トピックの ソース 情報を指定します。 ソースは、エンド ユーザーが確認できるパートナーによって提供されるイベントのソースに関するコンテキスト情報です。 この情報は、たとえば、エンド ユーザーがパートナー トピックのアクティブ化を検討している場合に役立ちます。
チャネルおよび関連するパートナー トピックに送信されるイベントの種類を宣言するには、[ イベントの種類の定義の追加] を選択します。 イベントの種類は、パートナー トピックでイベント サブスクリプションを作成するときに顧客に表示され、イベント ハンドラーの送信先に送信する特定のイベントの種類を選択するために使用されます。
ページの下部にある [ 次へ: 追加機能 ] リンクを選択します。
[ 追加機能 ] ページで、次の手順に従います。
- エンド ユーザーが関連するパートナー トピックをアクティブ化するのに役立つ独自のアクティブ化メッセージを設定するには、[ 独自のアクティブ化メッセージを設定する] の横にあるチェック ボックスをオンにして、メッセージを入力します。
- 有効期限の場合は、このチャネルが作成された後の時間を設定します。このチャネルは、エンド ユーザーによってアクティブ化されていない場合、関連付けられているパートナー トピックとこのチャネルが自動的に削除されます。 1.[ 次へ: 確認と作成] を選択します。
[ 確認と作成 ] ページで、チャネルのすべての設定を確認し、ページの下部にある [作成 ] を選択します。
パートナー トピック オプション:
チャネルを管理する
チャネルを作成した場合は、リソースが作成されたら構成を更新する必要があります。
チャネルの [構成] に移動します。 パートナー トピックのアクティブ化、アクティブ化されていない場合の有効期限、イベントの種類の定義のメッセージを更新できます。
Important
構成ページを離れる前に、変更を保存することを忘れないでください。
イベント チャネルを作成する
パートナー トピック ルーティング モードのイベントで [ソース] 属性を選択した場合は、このセクションの手順に従ってイベント チャネルを作成します。
Important
- チャネル は新しいルーティング リソースの種類であり、推奨されるオプションです。
作成した名前空間の [概要 ] ページに移動します。
partner-namespace-overview.pngツール バーの [ + イベント チャネル ] を選択します。
[ イベント チャネルの作成 - 基本 ] ページで、次の情報を指定します。
[ チャネルの詳細 ] セクションで、次の手順を実行します。
- [イベント チャネル名] に、イベント チャネルの名前を入力します。
- ソースを入力 します。 ソースに適した値を把握するには、 クラウド イベント 1.0 の仕様 を参照してください。 また、 このクラウド イベント スキーマの例も参照してください。
[ 宛先の詳細 ] セクションで、このイベント チャネル用に作成される宛先パートナー トピックの詳細を入力します。
- パートナー トピック を作成するサブスクリプションの ID を 入力します。
- パートナー トピック リソースが作成されるリソース グループの名前 を入力します。
- パートナー トピックの名前を入力します。
ページの下部にある [ 次へ: フィルター ] を選択します。
[ フィルター ] ページで、フィルターを追加します。 次の手順を実行します。
各イベントの属性をフィルター処理します。 すべてのフィルターに一致するイベントのみが配信されます。 最大 25 個のフィルターを指定できます。 比較では、大文字と小文字は区別されません。 フィルターに使用される有効なキーは、イベント スキーマによって異なります。 次の例では、キーに
eventid、source、eventtype、およびeventtypeversioinを使用できます。.を入れ子演算子として使用して、データ ペイロード内のカスタム プロパティを使用することもできます。 たとえば、data、data.key、data.key1.key2などです。ページの下部にある [ 次へ: その他の機能 ] を選択します。
[ その他の機能 ] ページでは、パートナー トピックの 有効期限 と 説明を設定できます。
有効期限は、トピックとそれに関連付けられているイベント チャネルが、顧客によってアクティブ化されていない場合に自動的に削除される時刻です。 時刻が指定されていない場合は、既定値の 7 日間が使用されます。 チェック ボックスをオンにして、独自の有効期限を指定します。
このトピックはユーザーが作成しないリソースであるため、 説明 はユーザーがこのトピックの性質を理解するのに役立ちます。 何も設定されていない場合は、一般的な説明が提供されます。 チェックボックスをオンにして、独自のパートナー トピックの説明を設定します。
[ 次へ: 確認と作成] を選択します。
[ 確認と作成] で設定を確認し、[ 作成 ] を選択してイベント チャネルを作成します。
パートナー トピックのアクティブ化
ユーザーが自分の Azure サブスクリプションで作成したパートナー トピックをサブスクライブする前に、最初にパートナー トピックをアクティブ化します。 詳細については、「 パートナーのアクティブ化」トピックを参照してください。
次のステップ
パートナー イベント機能の詳細については、次の記事を参照してください。