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

Event Grid サブスクリプションを作成するには、 Create Event サブスクリプション操作に対して要求を送信します。To create an Event Grid subscription, you send a request to the Create Event subscription operation. 次の形式を使用します。Use the following format:

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 という名前のストレージ アカウントのイベント サブスクリプションを作成するには、次の形式を使用します。For example, to create an event subscription for a storage account named examplestorage in a resource group named examplegroup, use the following format:

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、"-" だけです。The Event Subscription name must be 3-64 characters in length and can only contain a-z, A-Z, 0-9, and "-". この記事は、要求の本体のプロパティとスキーマについて説明します。The article describes the properties and schema for the body of the request.  

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

プロパティProperty TypeType 説明Description
destinationdestination objectobject エンドポイントを定義するオブジェクト。The object that defines the endpoint.
filterfilter オブジェクトobject イベントの種類をフィルター処理するための省略可能なフィールド。An optional field for filtering the types of events.

対象オブジェクトdestination object

プロパティProperty TypeType 説明Description
endpointTypeendpointType stringstring サブスクリプションのエンドポイントの種類 (webhook/HTTP、イベント ハブ、またはキュー)。The type of endpoint for the subscription (webhook/HTTP, Event Hub, or queue).
endpointUrlendpointUrl stringstring このイベント サブスクリプションのイベントの送信先 URL。The destination URL for events in this event subscription.

フィルター オブジェクトfilter object

プロパティProperty TypeType 説明Description
includedEventTypesincludedEventTypes arrayarray イベント メッセージのイベントの種類がこれらのイベントの種類名のいずれかと完全に一致した場合に、適合します。Match when the event type in the event message is an exact match to one of these event type names. イベント名がイベント ソースに対して登録済みのイベントの種類名と一致しない場合は、エラーを発生させます。Raises an error when event name does not match the registered event type names for the event source. 既定では、すべてのイベントの種類と一致します。Default matches all event types.
subjectBeginsWithsubjectBeginsWith stringstring イベント メッセージの件名フィールドに対する、プレフィックス一致のフィルター。A prefix-match filter to the subject field in the event message. 既定値または空の文字列はすべて一致します。The default or empty string matches all.
subjectEndsWithsubjectEndsWith stringstring イベント メッセージの件名フィールドに対する、サフィックス一致のフィルター。A suffix-match filter to the subject field in the event message. 既定値または空の文字列はすべて一致します。The default or empty string matches all.
isSubjectCaseSensitiveisSubjectCaseSensitive stringstring フィルターの大文字小文字の一致を制御します。Controls case-sensitive matching for filters.

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

{
  "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"
    }
  }
}

次の手順Next steps