クイック スタート:Event Grid を使用して Azure Functions にカスタム イベントをルーティングする

Azure Event Grid は、クラウドのイベント処理サービスです。 Azure Functions は、サポートされているイベント ハンドラーの 1 つです。 この記事では、Azure portal を使用し、カスタム トピックを作成してそのトピックをサブスクライブし、イベントをトリガーして結果を表示します。 イベントを Azure Functions に送信します。

Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。

Azure 関数アプリを作成する

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

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

  3. カテゴリのリストで [コンピューティング]選択します

  4. Function App の上にマウス ポインターを合わせて (選択しない)、選択+します。

    Screenshot showing the select of Create link for a Function App.

  5. Create Function App ウィザードの [基本] ページで、次の手順を実行します。

    1. 関数アプリを作成する [Azure サブスクリプション] を選択します。

    2. 新しいリソース グループを作成するか、既存のリソース グループを選択します。

    3. 関数アプリの名前を指定します。

    4. [ランタイム スタック] で、[.NET] を選択します。

    5. 最も近いリージョンを選択します。

    6. ページの下部にある [次へ: ストレージ] を選択します。

      Screenshot showing the Basics tab of the Create Function App page.

  6. [ストレージ] ページで、新しいストレージ アカウントを作成するか、関数アプリに関連付ける既存のストレージ アカウントを選択し、ページの下部にある [確認と作成] を選択します。

    Screenshot showing the Storage tab of the Create Function App page.

  7. [確認と作成] ページで、設定を確認し、ページの下部にある [作成] を選択し、関数アプリを作成ます。

  8. デプロイが成功したら、[リソースに移動] を選択して、関数アプリのホーム ページに移動します。

関数を作成する

カスタム トピックをサブスクライブする前に、イベントを処理する関数を作成します。

  1. [関数アプリ] ページで、右側のウィンドウの [Azure portal で作成] リンクを選択します。

    Screenshot showing the selection of Create function link.

  2. [関数の作成] ページで、次の手順に従います。

    1. [テンプレートの選択] セクションで、フィルターまたは検索ボックスに「Azure Event Grid トリガー」と入力します。

    2. テンプレート リストから [Azure Event Grid トリガー] テンプレートを選択します。

    3. 下部ペインのテンプレートの詳細セクションで、関数の名前を入力します。 この例では、HandleEventsFunc です。

    4. [作成] を選択します

      Screenshot showing select Event Grid trigger.

  3. HandleEventsFunc の [関数] ページで、左側のナビゲーション メニューで [コード + テスト] を選択し、コードを次のコードに置き換えて、コマンド バーの [保存] を選択します。

    #r "Azure.Messaging.EventGrid"
    #r "System.Memory.Data"
    
    using Azure.Messaging.EventGrid;
    using System;
    
    public static void Run(EventGridEvent eventGridEvent, ILogger log)
    {
        log.LogInformation(eventGridEvent.Data.ToString());
    }        
    

    Image showing the selection Code + Test menu for an Azure function.

  4. 左側のメニューで [モニター] を選択し、受信したイベント情報を表示できるように、ブラウザーのこのウィンドウまたはタブを開いたままにします。

    Screenshot showing the Monitor view the Azure function.

カスタム トピックの作成

Event Grid のトピックは、イベントの送信先となるユーザー定義のエンドポイントになります。

  1. Web ブラウザー ウィンドウの新しいタブで、Azure portal にサインインします。

  2. トピックの検索バーで、Event Grid トピックを検索し、[Event Grid トピック] を選択します。

    Image showing the selection of Event Grid topics.

  3. [Event Grid トピック] ページで、コマンド バーの [+ 作成] を選択します。

    Screenshot showing the Create button to create an Event Grid topic.

  4. [トピックの作成] ページで、次の手順に従います。

    1. Azure サブスクリプションを選択します。

    2. 前の手順と同じリソース グループを選択します。

    3. カスタム トピックの一意の名前を指定します。 トピック名は、DNS エントリによって表されるため、一意である必要があります。 画像に示されている名前は使用しないでください。 代わりに、必ず 3 - 50 文字以内で、a - z、A - Z、0 - 9、および "-" のみを含む独自の名前を作成します。

    4. Event Grid トピックの場所を選択します。

    5. [Review + create](レビュー + 作成) を選択します。

      Screenshot showing the Create Topic page.

    6. [確認および作成] ページで、設定を確認し、 [作成] を選択します。

  5. カスタム トピックが作成されたら、[リソースに移動] リンクを選択して、作成したトピックに対して次の [Event Grid トピック] ページを表示します。

    Image showing the home page for your Event Grid custom topic.

カスタム トピックのサブスクライブ

どのイベントを追跡し、どこにイベントを送信するかは、Event Grid トピックをサブスクライブすることによって Event Grid に伝えます。

  1. 次に、カスタム トピックの [Event Grid トピック] ページで、ツール バーの + [イベント サブスクリプション] を選択します。

    Image showing the selection of Add Event Subscription on the toolbar.

  2. [イベント サブスクリプションの作成] ページで、次の手順に従います。

    1. イベント サブスクリプションの名前を入力します。

    2. [エンドポイントのタイプ][Azure Function] を選択します。

    3. [エンドポイントの構成] を選択 します

      Image showing event subscription values.

    4. 関数エンドポイントに対し、関数アプリが存在する Azure サブスクリプションとリソース グループを選択して、先ほど作成した関数アプリと関数を選択します。 [選択の確認] を選択します。

      Image showing the Select Azure Function page showing the selection of function you created earlier.

    5. この手順は省略可能ですが、運用環境のシナリオについては推奨されます。 [イベント サブスクリプションの作成] ページで、 [高度な機能] タブに切り替え、 [バッチごとの最大イベント数] および [優先バッチ サイズ (KB 単位)] の値を設定します。

      バッチ処理を使用すると、高スループットが得られます。 [バッチごとの最大イベント数] には、サブスクリプションでバッチに含めるイベントの最大数を設定します。 優先バッチ サイズでは、バッチ サイズとして優先される上限をキロバイト単位で設定しますが、1 つのイベントがこのしきい値を超えると、その上限を超えてしまう可能性があります。

      Image showing batching settings for an event subscription.

    6. [イベント サブスクリプションの作成] ページで、 [作成] を選択します。

トピックへのイベントの送信

では、イベントをトリガーして、Event Grid がメッセージをエンドポイントに配信するようすを見てみましょう。 Azure CLI または PowerShell を使用して、テスト イベントをカスタム トピックに送信します。 通常はイベント データをアプリケーションまたは Azure サービスから送信することになります。

最初の例では、Azure CLI を使用しています。 この例では、カスタム トピックの URL とキー、およびサンプル イベント データを取得します。 <topic name> には、実際のカスタム トピック名を使用してください。 これによりサンプルのイベント データが作成されます。 JSON の data 要素がイベントのペイロードです。 このフィールドには、適切な形式の JSON であればどのようなものでも格納することができます。 また、高度なルーティングやフィルタリングを行う場合には、subject フィールドを使用することもできます。 CURL は、HTTP 要求を送信するユーティリティです。

Azure CLI

  1. Azure portal で、 [Cloud Shell] を選択します。 Cloud Shell ウィンドウの左上隅の [Bash] を選択します。

    Image showing Cloud Shell - Bash window

  2. コマンドで使用される topicnameresourcegroupname の変数を設定します。

    TOPICNAME は実際の Event Grid トピックの名前で置き換えます。

    topicname="TOPICNAME"
    

    RESOURCEGROUPNAME は、Event Grid トピックを含む Azure リソース グループの名前に置き換えます。

    resourcegroupname="RESOURCEGROUPNAME"
    
  3. 次のコマンドを実行して、トピックのエンドポイントを取得します。コマンドをコピーして貼り付けた後、コマンドを実行する前にトピック名リソース グループ名を更新してください。

    endpoint=$(az eventgrid topic show --name $topicname -g $resourcegroupname --query "endpoint" --output tsv)
    
  4. 次のコマンドを実行して、カスタム トピックのキーを取得します。コマンドをコピーして貼り付けた後、コマンドを実行する前にトピック名リソース グループ名を更新してください。

    key=$(az eventgrid topic key list --name $topicname -g $resourcegroupname --query "key1" --output tsv)
    
  5. イベント定義を含む次のステートメントをコピーし、Enter キーを押します。

    event='[ {"id": "'"$RANDOM"'", "eventType": "recordInserted", "subject": "myapp/vehicles/motorcycles", "eventTime": "'`date +%Y-%m-%dT%H:%M:%S%z`'", "data":{ "make": "Ducati", "model": "Monster"},"dataVersion": "1.0"} ]'
    
  6. 次の Curl コマンドを実行して、イベントを送信します。

    curl -X POST -H "aeg-sas-key: $key" -d "$event" $endpoint
    

Azure PowerShell

2 番目の例では、PowerShell を使用して、同様の手順を実行します。

  1. Azure portal で [Cloud Shell] を選択します (または https://shell.azure.com/ にアクセスします)。 Cloud Shell ウィンドウの左上隅の [PowerShell] を選択します。 「Azure CLI」セクションにあるサンプルの Cloud Shell ウィンドウの画像を参照してください。

  2. 次の変数を設定します。 コマンドをコピーして貼り付けた後、トピック名リソース グループ名を更新してから、次のコマンドを実行します。

    $resourceGroupName = "RESOURCEGROUPNAME"
    
    $topicName = "TOPICNAME"
    
  3. 次のコマンドを実行して、トピックのエンドポイントキーを取得します。

    $endpoint = (Get-AzEventGridTopic -ResourceGroupName $resourceGroupName -Name $topicName).Endpoint
    $keys = Get-AzEventGridTopicKey -ResourceGroupName $resourceGroupName -Name $topicName
    
  4. イベントを準備します。 ステートメントをコピーし、Cloud Shell ウィンドウ内で実行します。

    $eventID = Get-Random 99999
    
    #Date format should be SortableDateTimePattern (ISO 8601)
    $eventDate = Get-Date -Format s
    
    #Construct body using Hashtable
    $htbody = @{
        id= $eventID
        eventType="recordInserted"
        subject="myapp/vehicles/motorcycles"
        eventTime= $eventDate   
        data= @{
            make="Ducati"
            model="Monster"
        }
        dataVersion="1.0"
    }
    
    #Use ConvertTo-Json to convert event body from Hashtable to JSON Object
    #Append square brackets to the converted JSON payload since they are expected in the event's JSON payload syntax
    $body = "["+(ConvertTo-Json $htbody)+"]"
    
  5. Invoke-WebRequest コマンドレットを使用して、イベントを送信します。

    Invoke-WebRequest -Uri $endpoint -Method POST -Body $body -Headers @{"aeg-sas-key" = $keys.Key1}
    

関数がイベントを受信したことを確認する

以上でイベントがトリガーされ、そのメッセージが、Event Grid によってサブスクライブ時に構成したエンドポイントに送信されました。

  1. Azure 関数の [監視] ページに、呼び出しが表示されます。

    Screenshot showing the Invocations tab of the Monitor page.

  2. 呼び出しを選択して詳細を表示します。

    Screenshot showing the Invocation details.

  3. 右側の ウィンドウの [ログ ] タブを使用して、トピックのエンドポイントにイベントを投稿するときにログに記録されたメッセージを表示することもできます。

    Image showing the Monitor view of the Azure function with a log.

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

引き続きこのイベントを使用する場合は、この記事で作成したリソースをクリーンアップしないでください。 それ以外の場合は、この記事で作成したリソースを削除してください。

  1. 左側のメニューの [リソース グループ] を選択します。 左側のメニューにこれが表示されていない場合は、左側のメニューの [すべてのサービス] を選択し、 [リソース グループ] を選択します。

  2. リソース グループを選択して [リソース グループ] ページを開きます。

  3. ツール バーの [リソース グループの削除] を選択します。

  4. リソース グループの名前を入力して削除を確認し、 [削除] を選択します。

    Resource groups

    画像に表示されている他のリソース グループは、Cloud Shell ウィンドウによって作成および使用されたものです。 後で Cloud Shell ウィンドウを使用しない場合はこれを削除してください。

次のステップ

トピックを作成し、イベントをサブスクライブする方法がわかったら、Event Grid でできることについて、さらに情報を収集しましょう。

さまざまなプログラミング言語を使用して Event Grid でイベントを発行および使用する方法については、次のサンプルを参照してください。