アクセスキーを使ってAzure Event Gridのカスタムトピックにイベントを公開する

Event Gridのカスタムトピックは、アプリケーションが独自のイベントを送信するエンドポイントであり、Event Gridがそれらのイベントを関心のある購読者にルーティングできるようにします。 この記事では、アクセスキーを使ってカスタムトピックにイベントを公開する方法を紹介しており、Microsoft Entra IDの設定なしでリクエストを認証できます。 トピックエンドポイントとアクセスキーを取得し、イベントペイロードをフォーマットし、サンプルイベントを送信し、応答を確認します。

サービスレベル契約(SLA)は、期待されるフォーマットに合致する投稿にのみ適用されます。

前提条件

• Azure Event Grid のカスタム トピック。 作成するには、「Azureポータルを使ってウェブエンドポイントにカスタムイベントを送信する」をご覧ください。
• Azure CLI、Azure PowerShell、またはAzureポータルへのアクセスでトピックエンドポイントとアクセスキーを取得することができます。
• curlのようなHTTP POSTリクエストを送信できるツールです。

トピック エンドポイントを取得する

カスタムトピックにイベントを公開するには、以下のURI形式でHTTPのPOSTリクエストを送信します: https://<topic-endpoint>?api-version=2018-01-01。 たとえば、https://exampletopic.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01 は有効な URI です。 カスタムトピックのエンドポイントを取得するには、Azure portal、Azure CLI、またはAzure PowerShellを使いましょう。

az eventgrid topic show --name <topic-name> -g <topic-resource-group> --query "endpoint"

(Get-AzEventGridTopic -ResourceGroupName <topic-resource-group> -Name <topic-name>).Endpoint

アクセス キーを取得する

要求では、認証用のキーを含む aeg-sas-key という名前のヘッダー値を設定します。 たとえば、aeg-sas-key: xxxxxxxxxxxxxxxxxxxxxxx は有効なヘッダー値です。 カスタムトピックのキーを取得するには、Azure portal、Azure CLI、またはAzure PowerShellを使いましょう。

az eventgrid topic key list --name <topic-name> -g <topic-resource-group> --query "key1"

(Get-AzEventGridTopicKey -ResourceGroupName <topic-resource-group> -Name <topic-name>).Key1

イベントペイロードのフォーマット

各イベントをJSONオブジェクトとしてフォーマットします。 最上位フィールドは標準的なリソース定義イベントと同じで、 data プロパティはカスタムトピック固有のプロパティを保持しています。 出版者として、 data オブジェクトの内容を定義します。 各プロパティの説明については、Azure Event Grid Event schema を参照してください。

[
  {
    "id": string,
    "eventType": string,
    "subject": string,
    "eventTime": string-in-date-time-format,
    "data":{
      object-unique-to-each-publisher
    },
    "dataVersion": string
  }
]

ペイロードを作る際には、以下のサイズ制限を念頭に置いてください:

• イベントアレイの総サイズは最大1MBまで可能です。
• 単一イベントの最大サイズは1MBです。 64KBを超えるイベントは64KB単位で課金されます。
• バッチには最大5,000件のイベントを含めることができます。

以下の例は有効なイベントペイロードを示しています:

[{
  "id": "1807",
  "eventType": "recordInserted",
  "subject": "myapp/vehicles/motorcycles",
  "eventTime": "2017-08-10T21:03:07+00:00",
  "data": {
    "make": "Ducati",
    "model": "Monster"
  },
  "dataVersion": "1.0"
}]

サンプル イベントを送信する

このセクションでは、サンプル イベントをカスタム トピックに送信する方法について説明します。

endpoint=$(az eventgrid topic show --name <topic name> -g <resource group name> --query "endpoint" --output tsv)

key=$(az eventgrid topic key list --name <topic name> -g <resource group name> --query "key1" --output tsv)

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 -X POST -H "aeg-sas-key: $key" -d "$event" $endpoint

$resourceGroupName = "<resource group name>"
$topicName = "<topic name>"

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

$keys = Get-AzEventGridTopicKey -ResourceGroupName $resourceGroupName -Name $topicName

$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)+"]"

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

応答を確認する

トピックエンドポイントに投稿すると、返信が届きます。 応答は、標準 HTTP 応答コードです。 いくつかの一般的な応答を次に示します。

エラーについては、メッセージ本文は以下の形式を使用します。

{
    "error": {
        "code": "<HTTP status code>",
        "message": "<description>",
        "details": [{
            "code": "<HTTP status code>",
            "message": "<description>"
    }]
  }
}

関連するコンテンツ

• Event Grid メッセージ配信の監視: イベント配信を追跡およびトラブルシューティングする方法について説明します。
• Event Grid のセキュリティと認証: 認証キーを使用してイベントをセキュリティで保護する方法について説明します。
• Event Grid サブスクリプション スキーマ: Event Grid サブスクリプションの作成に関する詳細なガイダンス。