Event Grid サブスクリプション スキーマ

Event Grid サブスクリプションを作成するには、 Create Event サブスクリプション操作に対して要求を送信します。 次の形式を使用します。

PUT /subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/{resource-provider}/{resource-type}/{resource-name}/Microsoft.EventGrid/eventSubscriptions/{event-type-definitions}?api-version=2018-01-01

たとえば、examplegroup という名前のリソース グループに、examplestorage という名前のストレージ アカウントのイベント サブスクリプションを作成するには、次の形式を使用します。

PUT /subscriptions/{subscription-id}/resourceGroups/examplegroup/providers/Microsoft.Storage/storageaccounts/examplestorage/Microsoft.EventGrid/eventSubscriptions/{event-type-definitions}?api-version=2018-01-01

イベント サブスクリプションの名前は、長さが 3 から 64 文字でなければならず、使用できるのは a から z、A から Z、0 から 9、"-" だけです。 この記事は、要求の本体のプロパティとスキーマについて説明します。  

イベント サブスクリプションのプロパティ

プロパティ Type [説明]
destination object エンドポイントを定義するオブジェクト。
filter object イベントの種類をフィルター処理するための省略可能なフィールド。

対象オブジェクト

プロパティ Type 説明
endpointType string サブスクリプションのエンドポイントの種類 (webhook/HTTP、イベント ハブ、またはキュー)。
endpointUrl string このイベント サブスクリプションのイベントの送信先 URL。

フィルター オブジェクト

プロパティ Type 説明
includedEventTypes array イベント メッセージのイベントの種類がこれらのイベントの種類名のいずれかと完全に一致した場合に、適合します。 イベント名がイベント ソースに対して登録済みのイベントの種類名と一致しない場合は、エラーを発生させます。 既定では、すべてのイベントの種類と一致します。
subjectBeginsWith string イベント メッセージの件名フィールドに対する、プレフィックス一致のフィルター。 既定値または空の文字列はすべて一致します。
subjectEndsWith string イベント メッセージの件名フィールドに対する、サフィックス一致のフィルター。 既定値または空の文字列はすべて一致します。
isSubjectCaseSensitive string フィルターの大文字小文字の一致を制御します。
enableAdvancedFilteringOnArrays boolean 高度なフィルター処理でキーの配列を使用できるようにします。 詳細については、高度なフィルター処理に関するページを参照してください。

サブスクリプション スキーマの例

{
  "properties": {
    "destination": {
      "endpointType": "webhook",
      "properties": {
          "endpointUrl": "https://example.azurewebsites.net/api/HttpTriggerCSharp1?code=VXbGWce53l48Mt8wuotr0GPmyJ/nDT4hgdFj9DpBiRt38qqnnm5OFg=="
      }
    },
    "filter": {
      "includedEventTypes": [ "Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobDeleted" ],
      "subjectBeginsWith": "/blobServices/default/containers/mycontainer/log",
      "subjectEndsWith": ".jpg",
      "isSubjectCaseSensitive ": "true"
    }
  }
}

次のステップ

  • Event Grid の概要については、Event Grid の紹介に関する記事を参照してください。