Azure portal を使って Azure Event Grid のパートナーとしてオンボード

  • [アーティクル]

この記事では、サードパーティの SaaS プロバイダー (パートナーとも呼ばれます) が Event Grid にオンボードされ、サービスからイベントが発行できるようにする方法と、それらのイベントがエンド ユーザーによってどのように使用されるかについて説明します。

重要

パートナーは、イベントを Azure Event Grid に発行し、そこからイベントを受信することもできます。 これらの機能は、パートナー イベント機能を通じて有効になります。 パートナー イベントの詳細については、パートナー イベントの概要に関するページを参照して、理解しておく必要がある主要な概念を参照してください。また、この記事の手順に従ってください。

パートナー向けのオンボード プロセス

簡単に言うと、ユーザーがサービスのイベントを使用できるようにするには、通常、次のプロセスが必要です。

  1. Event Grid サービス チームにパートナーになることに関心があることを連絡します。

  2. Azure サブスクリプションを使用して Event Grid リソース プロバイダーを登録します。

  3. パートナー登録を作成します。

  4. 名前空間を作成します。

  5. チャネルとパートナー トピックを 1 つの手順で作成します。

    重要

    パートナー トピックをサポートするイベント チャネル (レガシ) を作成できる場合があります。 チャネルは、新しいルーティング リソースの種類であり、パートナー トピックを介したイベントの送信をサポートする推奨オプションです。 イベント チャネルはレガシ リソースであり、間もなく非推奨になります。

  6. パートナー イベントの機能をエンド ツー エンドでテストします。

手順 5 では、どのような種類のユーザー エクスペリエンスを提供するかを決める必要があります。 次のようなオプションがあります。

  • 独自のソリューションを提供します。通常は、SDK または REST API を使用してユーザーのドメインでホストされている Web グラフィカル ユーザー インターフェイス (GUI) で、チャネル (最新かつ推奨) またはイベント チャネル (レガシ) とそれに対応するパートナー トピックを作成します。 このオプションを使用すると、パートナー トピックを作成するサブスクリプションとリソース グループをユーザーに要求できます。
  • Azure portal または CLI を使用して、チャネル (推奨) またはイベント チャネル (レガシ) と関連付けられているパートナー トピックを作成します。 このオプションを使用すると、ユーザーの Azure サブスクリプションと、パートナー トピックを作成するリソース グループを何らかの形で取得する必要があります。

この記事では、Azure portal を使って Azure Event Grid のパートナーとしてオンボードする方法を説明します。

パートナーになることへの関心の連絡

Event Grid チーム (askgrid@microsoft.com) に連絡して、パートナーになることに関心があることをお伝えください。 パートナー イベントのユース ケース、ペルソナ、オンボード プロセス、機能、価格などに関する詳細情報を提供するメッセージ交換を行います。

前提条件

残りの手順を完了するには次を行います。

Event Grid リソース プロバイダーを登録する

これまでに Event Grid を使用したことがない場合は、Event Grid リソース プロバイダーを登録する必要があります。 Event Grid を使用したことがある場合は、次のセクションに進んでください。

Azure portal で、次の手順を実行します。

  1. 左側のメニューで [サブスクリプション] を選択します。

  2. サブスクリプションの一覧から Event Grid に使用するサブスクリプションを選択します。

  3. [サブスクリプション] ページで、左側のメニューの [設定] の下の [リソース プロバイダー] を選択します。

  4. Microsoft.EventGrid を検索し、[状態] が [未登録] であることを確認します。

  5. プロバイダーの一覧で [Microsoft.EventGrid] を選択します。

  6. コマンド バーの [登録] を選択します。

    Image showing the registration of Microsoft.EventGrid provider with the Azure subscription.

  7. 最新の情報に更新して、Microsoft.EventGrid の状態が [登録済み] に変更されたことを確認します。

    Image showing the successful registration of Microsoft.EventGrid provider with the Azure subscription.

パートナー登録を作成する

  1. Azure portal にサインインします。

  2. 左側のナビゲーション ウィンドウで [すべてのサービス] を選択し、検索バーに Event Grid パートナー登録を入力して選択します。

  3. [Event Grid のパートナー登録] ページで、コマンド バーの [+ 作成] を選択するか、ページ上の [Create Event Grid partner registrations] (Event Grid のパートナー登録を作成する) リンクを選択します。

    Add partner registration link

  4. [パートナー トピックの種類の登録 - 基本] ページで、次の情報を入力します。

    1. [プロジェクトの詳細] セクションで、次の手順に従います。
      1. Azure サブスクリプションを選択します。
      2. 既存の Azure リソース グループを選択するか、新しいリソース グループを作成します。
    2. [登録の詳細] セクションで、次の手順に従います。
      1. [登録名] に、登録する名前を入力します。
      2. [組織名] に、組織の名前を入力します。
    3. [パートナー リソースの種類] セクションで、[パートナー トピックの作成] ページに表示されるリソースの種類に関する詳細を入力します。

      1. [パートナー リソースの種類の名前] に、リソースの種類の名前を入力します。

      2. [表示名] には、パートナー トピック (リソース) の種類のわかりやすい表示名を入力します。

      3. リソースの種類の説明を入力します。

      4. シナリオの説明を入力します。 ここではリソースのパートナー トピックを使用する方法またはシナリオについて説明します。

        Create partner registration

  5. Next:カスタム サービス がページの下部にあるので、これを選択します。 [Create Partner Registration] (パートナー登録の作成) ページの [顧客サービス] タブで、イベント ソースに問題が発生した場合に、サブスクライバー ユーザーが連絡するために使用する情報を入力します。

    1. 電話番号を入力します。

    2. 電話番号の内線を入力します。

    3. サポート Web サイト URL を入力します。

      Create partner registration - customer service

  6. Next:タグ がページの下部にあるので、これをクリックします。

  7. [タグ] ページで、以下の値を構成します。

    1. 追加するタグの名前と値を入力します。 この手順は省略可能です。
    2. ページの下部にある [確認と作成] を選択して、登録 (パートナー トピックの種類) を作成します。

  8. [確認と作成] ページで 設定を確認し、[作成] を選択してパートナー登録を作成します。

パートナー名前空間を作成する

  1. Azure portal で、左側のナビゲーション メニューから [すべてのサービス] を選択し、検索バーに Event Grid Partner Namespace と入力して、一覧から選択します。

  2. [Event Grid のパートナー名前空間] ページで、ツール バーの [+ 作成] を選択します。

    Partner namespaces - Add link

  3. [パートナー名前空間の作成 - 基本] ページで、次の情報を指定します。

    1. [プロジェクトの詳細] セクションで、次の作業を行います。

      1. Azure サブスクリプションを選択します。
      2. 既存のリソース グループを選択するか、新しいリソース グループを作成します。

    2. [名前空間の詳細] セクションで、次の作業を行います。

      1. 名前空間の名前を入力します。

      2. 名前空間の場所を選択します。

      3. [Partner topic routing mode] (パートナー トピックのルーティング モード) では、[Channel name header] (チャネル名ヘッダー) または [Source attribute in event] (イベントのソース属性) を選択します。

        • チャネル名ヘッダールーティング: このルーティングの種類では、aeg-channel-name という名前の http ヘッダーにイベントをルーティングするチャネルの名前を指定して、イベントを発行します。 このオプションを選択すると、名前空間にチャネルが作成されます。
        • イベントのソース属性ルーティング。 このルーティング手法は、イベント内の source コンテキスト属性の値に基づきます。 このオプションを選択すると、イベント チャネルが作成されます。これは チャネルと同等のレガシであり、間もなく非推奨になります。

        重要

        • 名前空間が作成されると、ルーティング モードを更新することはできません。
        • チャネルは新しいルーティング リソースの種類であり、推奨されるオプションです。 イベント チャネルはレガシ リソースであり、間もなく非推奨になります。

    3. [Registration details] (登録の詳細) セクションで、次の手順を実行して、名前空間をパートナー登録に関連付けます。

      1. パートナー登録が存在するサブスクリプションを選択します。
      2. パートナー登録が含まれるリソース グループを選択します。
      3. ドロップダウン リストから [パートナー登録] を選択します。

    4. Next:タグ がページの下部にあるので、これをクリックします。

      Create partner namespace - basics page

  4. [タグ] ページで、タグを追加します (省略可能)。

    1. 追加するタグの名前と値を入力します。 この手順は省略可能です。
    2. ページ下部にある [確認と作成] を選択します。

  5. [確認および作成] ページで詳細を確認し、 [作成] を選択します。

チャネルの作成

[Partner topic routing mode] (パートナー トピックのルーティング モード) で [Channel name header] (チャネル名ヘッダー) を選択した場合は、このセクションの手順に従ってチャネルを作成します。

  1. 作成したパートナー名前空間の [概要] ページに移動し、コマンド バーの [+ チャネル] を選択します。

    Image showing the selection of Create Channel button on the command bar of the Event Grid Partner Namespace page.

  2. [Create Channel - Basics] (チャネルの作成 - 基本) ページで、次の手順を行います。

    1. チャネルの名前を入力します。 チャネル名は、作成されるリージョン全体で一意である必要があります。

    2. チャネルの種類として、[パートナー トピック] を選択します。

      パートナー トピックは、公開されたイベントを保持するリソースです。 後でハンドラーによって処理されるイベントを保持するパートナー トピックにイベントを転送する場合は、[パートナー トピック] を選択します。

    3. [パートナー トピック] を選択した場合は、次の詳細を入力します。

      1. パートナー トピックを作成するサブスクリプションの ID。

      2. パートナー トピックを作成するリソース グループ。

      3. パートナー トピックの名前。

      4. パートナー トピックのソース情報を指定します。 ソースは、エンド ユーザーが確認できる、パートナーによって提供されるイベントのソースに関するコンテキスト情報です。 この情報は、エンド ユーザーがパートナー トピックのアクティブ化を検討している場合などに役立ちます。

        Image showing the Create Channel - Basics page.

      5. チャネルや関連するパートナー トピックに送信されるイベントの種類を宣言するには、[Add event type definitions (イベントの種類の定義の追加)] を選択します。 イベントの種類は、パートナー トピックでイベント サブスクリプションを作成するときに顧客に表示され、イベント ハンドラーの送信先に送信する特定のイベントの種類を選択するために使用されます。

        Screenshot that shows the Event Types Definitions section with Add event types definitions option selected.

        Screenshot that shows the definition of a sample event type.

        Screenshot that shows a list with the event type definition that was added.

    4. ページの下部にある [次へ: 追加の機能] リンクを選択します。

    5. [追加の機能] ページで、次の手順に従います。

      1. エンド ユーザーが関連するパートナー トピックをアクティブ化するのに役立つ独自のアクティブ化メッセージを設定するには、[Set your own activation message] (独自のアクティブ化メッセージを設定する) の横にあるチェック ボックスをオンにし、メッセージを入力します。
      2. 有効期限については、エンド ユーザーによってアクティブ化されない場合に、関連付けられているパートナー トピックとこのチャネルを自動的に削除する、このチャネルが作成されてからの時間を設定します。 [次へ: 確認と作成:] を選択します。

      Image showing the Create Channel - Additional Features page.

    6. [確認と作成] ページで、チャネルのすべての設定を確認し、ページの下部にある [作成] を選択します。

      パートナー トピックのオプション: Image showing the Create Channel - Review + create page.

チャネルを管理する

チャネルを作成した場合は、リソースが作成されたら構成を更新する必要があります。

  1. チャネルの [構成] に移動します。 パートナー トピックのアクティブ化、アクティブ化されていない場合の有効期限、イベントの種類の定義に関するメッセージを更新できます。

    Screenshot that shows the Configuration page of a channel.

重要

[構成] ページを離れる前に、変更を保存することを忘れないでください。

イベント チャネルを作成する

[Partner topic routing mode] (パートナー トピックのルーティング モード) で [Source attribute in event] (イベントのソース属性) を選択した場合は、このセクションの手順に従ってイベント チャネルを作成します。

重要

  • チャネルは新しいルーティング リソースの種類であり、推奨されるオプションです。

  1. 作成した名前空間の [概要] ページにアクセスします。

    Partner namespace - overview page partner-namespace-overview.png

  2. ツールバーの [+ イベント チャネル] を選択します。

  3. [イベント チャネルの作成 - 基本] ページで、次の情報を指定します。

    1. [チャネルの詳細] セクションで、次の手順を実行します。

      1. [イベント チャネル名] には、イベント チャネルの名前を入力します。
      2. ソースを入力します。 ソースに適した値については、Cloud Events 1.0 の仕様に関するページを参照してください。 また、このクラウド イベント スキーマの例を参照してください。

    2. [宛先の詳細] セクションで、このイベント チャネルに対して作成される宛先パートナー トピックの詳細を入力します。

      1. パートナー トピックを作成するサブスクリプションの ID を入力します。
      2. パートナー トピック リソースを作成するリソース グループの名前を入力します。
      3. パートナー トピックの名前を入力します。

    3. Next:フィルター がページの下部にあるので、これをクリックします。

      Create event channel - basics page

  4. [フィルター] ページで、フィルターを追加します。 次の手順を実行します。

    1. 各イベントの属性をフィルター処理します。 すべてのフィルターに一致するイベントのみが配信されます。 フィルターは 25 個まで指定できます。 比較では、大文字と小文字は区別されません。 フィルターに使用する有効なキーは、イベント スキーマによって異なります。 次の例では、eventid、source、eventtype、eventtypeversioin をキーとして使用できます。 入れ子演算子として . を使用して、データ ペイロード内のカスタム プロパティを使用することもできます。 たとえば、data、data.key、data.key1.key2 などです。

    2. Next:追加機能 がページの下部にあるので、それを選択します。

      Create event channel - filters page

  5. [追加機能] ページで、パートナー トピックの有効期限および説明を設定できます。

    1. 有効期限は、トピックとそれに関連付けられているイベントチャネルが顧客によってアクティブ化されていない場合に、自動的に削除される時刻です。 時刻が指定されていない場合は、既定の 7 日間が使用されます。 チェックボックスをオンにして、独自の有効期限を指定します。

    2. このトピックはユーザーによって作成されていないリソースなので、 説明がこのトピックの性質を理解するのに役立ちます。 何も設定されていない場合は、一般的な説明が表示されます。 独自のパートナー トピックの説明を設定するチェックボックスをオンにします。

    3. 確認と作成 をクリックします。

      Create event channel - additional features page

  6. [確認と作成] では、設定を確認し、 [作成] を選択してイベント チャネルを作成します。

パートナー トピックをアクティブ化する

ユーザーは、自分の Azure サブスクリプションに作成されたパートナー トピックをサブスクライブする前に、まずパートナー トピックをアクティブにする必要があります。 詳細については、「パートナー トピックをアクティブ化する」を参照してください。

次のステップ

パートナー イベント機能の詳細について、次の記事をご覧ください。