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

[アーティクル]
07/02/2024

Azure Event Grid は、クラウドのイベントルーティングサービスです。 Azure Functions は、サポートされているイベントハンドラーの 1 つです。

このクイックスタートでは、Azure portal を使用し、カスタムトピックを作成してそのトピックをサブスクライブし、イベントをトリガーして結果を表示します。イベントを Azure 関数に送信します。

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

Visual Studio Code を使用して Event Grid トリガーで関数を作成する

このセクションでは、Visual Studio Code を使用して、Event Grid トリガーを使用して関数を作成します。

前提条件

サポートされているプラットフォームのいずれかにインストールされている Visual Studio Code
Azure Functions 拡張機能

関数を作成する

Visual Studio Code を開きます。
左側のバーで [Azure] を選択します。
左側のペインの [ワークスペース] セクションで、コマンドバーの [Azure Functions] ボタンを選択し、[関数の作成] を選択します。
関数コードを保存するフォルダーを選択します。
[新しいプロジェクトの作成] コマンドで、[言語] に [C#] を選択し、Enter キーを選択します。
.NET ランタイムの場合 .NET 8.0 Isolated LTS を選択し、Enter キーを選択します。
[関数のテンプレート] に [Azure Event Grid トリガー] を選択し、Enter キーを選択します。
[関数名] に関数の名前を入力し、Enter キーを選択します。
[名前空間] に、関数の名前空間の名前を入力し、Enter キーを選択します。
プロジェクトを現在のウィンドウまたは新しいウィンドウで開くか、ワークスペースに追加します。
関数が作成されるまで待ちます。関数の作成の状態が右下隅に表示されます。

YourFunctionName.cs ファイル (具体的には Run メソッド) のコードを表示します。これは、ロガーを使用して情報を出力します。

[Function(nameof(MyEventGridTriggerFunc))]
public void Run([EventGridTrigger] CloudEvent cloudEvent)
{
    _logger.LogInformation("Event type: {type}, Event subject: {subject}", cloudEvent.Type, cloudEvent.Subject);
}

関数を Azure にデプロイする

[Azure] ペインがまだ開いていない場合は、左側のバーの [Azure] ボタンを選択します。
プロジェクトにホバーして、[Azure へのデプロイ] ボタンを選択します。
コマンドパレットのドロップダウンリストで、[+ 新しい関数アプリの作成] を選択し、Enter キーを選択します。
[名前] に、新しい関数アプリのグローバルに一意の名前を入力し、Enter キーを選択します。
[ランタイムスタック] で、[.NET 8 Isolated] を選択します。
Azure リソースの [場所] には、近くのリージョンを選択します。
関数アプリの作成の状態は、下部ペインの [AZURE] タブに表示されます。関数アプリが作成されると、ローカルに作成した関数を関数アプリにデプロイする状態が表示されます。
デプロイが成功したら、関数アプリの作成が成功したことを示すメッセージを展開し、[Click to view resource]$クリックしてリソースを表示$ を選択してリソースを表示します。左側のペインの [リソース] セクションで、関数が選択されていることを確認します。
関数を右クリックし、[ポータルで開く] を選択します。
必要に応じて Azure にサインインし、関数の [関数アプリ] ページが表示されることを確認します。
下部のペインで、関数を選択します。
[ログ] タブに切り替えます。このタブまたはウィンドウを開いたままにして、このチュートリアルの後半で Event Grid トピックにイベントを送信するときにログに記録されるメッセージが見えるようにします。

カスタムトピックの作成

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

Web ブラウザーウィンドウの新しいタブで、Azure portal にサインインします。
トピックの検索バーで、Event Grid トピックを検索し、[Event Grid トピック] を選択します。
[トピック] ページで、コマンドバーの [+ 作成] を選択します。
[トピックの作成] ページで、次の手順に従います。
1. [サブスクリプション] で、Azure サブスクリプションを選択します。
2. [リソースグループ] で、前の手順と同じリソースグループを選択します。
3. [名前] に、カスタムトピックの一意の名前を指定します。トピック名は、ドメインネームシステム (DNS) エントリによって表されるため、一意である必要があります。
  
  例で使われている画像に示されている名前は使用しないでください。独自の名前を作成してください。 3 から 50 文字で、値 a から z、A から Z、0 から 9、ハイフン (-) のみを含める必要があります。
4. リージョンは、Event Grid トピックの場所を選択します。
5. [Review + create](レビュー + 作成) を選択します。
6. [確認と作成] タブで設定を確認し、[作成] を選択します。
カスタムトピックが作成されたら、[リソースへの移動] リンクを選択して、そのトピックの [Event Grid トピック] ページを開きます。

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

カスタムトピックの [Event Grid トピック] ページで、ツールバーの [+ イベントサブスクリプション] を選択します。
[イベントサブスクリプションの作成] ペインで、次の手順に従います。
1. [名前] に、イベントサブスクリプションの名前を入力します。
2. [イベントスキーマ] に、[クラウドイベントスキーマ v1.0] を選択します。
3. [エンドポイントのタイプ] で、 [Azure 関数] を選択します。
4. [エンドポイントを構成する] を選択します。
5. [Azure 関数の選択] ペインで、次の手順に従います。
  1. [サブスクリプション] では、関数がある Azure サブスクリプションを選択します。
  2. [リソースグループ] では、関数を含むリソースグループを選択します。
  3. [関数アプリ] では、お使いの関数アプリを選択します。
  4. [関数] では、関数アプリの関数を選択します。
  5. [選択の確認] を選択します。
6. この手順は省略可能ですが、運用環境のシナリオにはお勧めします。 [イベントサブスクリプションの作成] ペインで、[追加の機能] タブに切り替え、[バッチごとの最大イベント数] および [優先バッチサイズ (KB 単位)] の値を設定します。
  
  バッチ処理を使用すると、高いスループットが得られます。 [バッチごとの最大イベント数] には、サブスクリプションでバッチに含めるイベントの最大数を設定します。 [優先バッチサイズ (KB 単位)] は、バッチサイズとして優先される上限をキロバイト単位で設定しますが、1 つのイベントがこのしきい値より大きい場合は、その上限を超えてしまう可能性があります。
7. 次に、[イベントサブスクリプションの作成] ペインで、[作成] を選択します。

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

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

最初の例では、Azure CLI を使用しています。この例では、カスタムトピックの URL とキー、およびサンプルイベントデータを取得します。 topicname には、実際のカスタムトピック名を使用してください。これによりサンプルのイベントデータが作成されます。

JSON の data 要素がイベントのペイロードです。このフィールドには、適切な形式の JSON であればどのようなものでも格納することができます。また、高度なルーティングやフィルタリングを行う場合には、subject フィールドを使用することもできます。

cURL ツールは HTTP 要求を送信します。この記事では、cURL を使って、イベントをカスタムトピックに送信します。

Azure CLI

Azure portal で、 [Cloud Shell] を選択します。 Azure PowerShell モードにある場合は、[Bash に切り替える] を選択します。
コマンドで使用される topicname 変数と resourcegroupname 変数を設定します。

TOPICNAME は実際の Event Grid トピックの名前で置き換えます。
```
topicname="TOPICNAME"
```
RESOURCEGROUPNAME は、Event Grid トピックを含む Azure リソースグループの名前に置き換えます。
```
resourcegroupname="RESOURCEGROUPNAME"
```
次のコマンドを使用して、トピックのエンドポイントを取得します。コマンドをコピーして貼り付けた後、実行する前にトピック名とリソースグループ名を更新してください。
```
endpoint=$(az eventgrid topic show --name $topicname -g $resourcegroupname --query "endpoint" --output tsv)
```
次のコマンドを使用して、カスタムトピックのキーを取得します。コマンドをコピーして貼り付けた後、実行する前にトピック名とリソースグループ名を更新してください。
```
key=$(az eventgrid topic key list --name $topicname -g $resourcegroupname --query "key1" --output tsv)
```

イベント定義を含む次のステートメントをコピーし、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"} ]'

次の cURL コマンドを実行して、イベントを送信します。
```
curl -X POST -H "aeg-sas-key: $key" -d "$event" $endpoint
```
関数からのメッセージが、Azure portal の関数の [ログ] タブに表示されることを確認します。

Azure PowerShell

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

Azure portal で [Cloud Shell] を選択します (または、Azure Cloud Shell ページに移動します)。 Cloud Shell ウィンドウの左上隅で、[PowerShell に切り替える] を選択します。
次の変数を設定します。コマンドをコピーして貼り付けた後、トピック名とリソースグループ名を更新してから、次のコマンドを実行します。
```
$resourceGroupName = "RESOURCEGROUPNAME"
```
```
$topicName = "TOPICNAME"
```

次のコマンドを実行して、トピックのエンドポイントとキーを取得します。

$endpoint = (Get-AzEventGridTopic -ResourceGroupName $resourceGroupName -Name $topicName).Endpoint
$keys = Get-AzEventGridTopicKey -ResourceGroupName $resourceGroupName -Name $topicName

イベントを準備します。これらのステートメントをコピーし、Cloud Shell ウィンドウ内で実行します。

$eventID = Get-Random 99999

#Date format should be SortableDateTimePattern (ISO 8601)
$eventDate = Get-Date -Format s

#Construct the body by using a hash table
$htbody = @{
    id= $eventID
    eventType="recordInserted"
    subject="myapp/vehicles/motorcycles"
    eventTime= $eventDate   
    data= @{
        make="Ducati"
        model="Monster"
    }
    dataVersion="1.0"
}

#Use ConvertTo-Json to convert the event body from a hash table to a JSON object
#Append square brackets to the converted JSON payload because they're expected in the event's JSON payload syntax
$body = "["+(ConvertTo-Json $htbody)+"]"

Invoke-WebRequest コマンドレットを使用してイベントを送信します。

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

関数からのメッセージが、Azure portal の関数の [ログ] タブに表示されることを確認します。

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

イベントがトリガーされ、そのメッセージが、Event Grid によってサブスクライブ時に構成したエンドポイントに送信されました。これで、関数がこれを受け取ったかどうかを確認できます。

関数の [モニター] ページで、呼び出しを見つけます。
呼び出しを選んで詳細を表示します。

トピックのエンドポイントにイベントを投稿するときに、右側のペインにある [ログ] タブを使って、ログされたメッセージを確認することもできます。

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

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

左側のメニューの [リソースグループ] を選択します。

別の方法として、左側のメニューで [すべてのサービス] を選択してから、[リソースグループ] 選択します。
リソースグループを選択して、詳細のペインを開きます。
ツールバーの [リソースグループの削除] を選びます。
リソースグループの名前を入力して削除を確認し、[削除] を選択します。

Cloud Shell ウィンドウが作成され、リソースグループ ページに表示されているその他のリソースグループが使用されました。後で Cloud Shell ウィンドウを使用する予定がない場合は、このリソースグループを削除してください。

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

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

次の方法で共有

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

Visual Studio Code を使用して Event Grid トリガーで関数を作成する

前提条件

関数を作成する

関数を Azure にデプロイする

カスタムトピックの作成

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

Azure CLI

Azure PowerShell

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

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

フィードバック

その他のリソース

次の方法で共有

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

Visual Studio Code を使用して Event Grid トリガーで関数を作成する

前提条件

関数を作成する

関数を Azure にデプロイする

カスタム トピックの作成

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

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

Azure CLI

Azure PowerShell

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

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

関連するコンテンツ

フィードバック

その他のリソース

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

カスタムトピックの作成

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