Service Bus 用の Azure Event Grid イベント スキーマAzure Event Grid event schema for Service Bus

この記事では、Service Bus イベントのプロパティとスキーマについて説明します。This article provides the properties and schema for Service Bus events. イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。 For an introduction to event schemas, see Azure Event Grid event schema.

サンプル スクリプトとチュートリアルの一覧については、Service Bus のイベント ソースに関する記事を参照してください。For a list of sample scripts and tutorials, see Service Bus event source.

使用可能なイベントの種類Available event types

Service Bus から出力されるイベントの種類は次のとおりです。Service Bus emits the following event types:

イベントの種類Event type 説明Description
Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListenersMicrosoft.ServiceBus.ActiveMessagesAvailableWithNoListeners キューまたはサブスクリプションにアクティブなメッセージがあり、リッスンしているレシーバーがない場合に生成されます。Raised when there are active messages in a Queue or Subscription and no receivers listening.
Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenerMicrosoft.ServiceBus.DeadletterMessagesAvailableWithNoListener 配信不能キューにアクティブなメッセージがあり、アクティブなレシーバーがない場合に生成されます。Raised when there are active messages in a Dead Letter Queue and no active listeners.

イベントの例Example event

次の例では、リスナー イベントがないアクティブなメッセージのスキーマを示します。The following example shows the schema of active messages with no listeners event:

[{
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{your-rg}/providers/Microsoft.ServiceBus/namespaces/{your-service-bus-namespace}",
  "subject": "topics/{your-service-bus-topic}/subscriptions/{your-service-bus-subscription}",
  "eventType": "Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners",
  "eventTime": "2018-02-14T05:12:53.4133526Z",
  "id": "dede87b0-3656-419c-acaf-70c95ddc60f5",
  "data": {
    "namespaceName": "YOUR SERVICE BUS NAMESPACE WILL SHOW HERE",
    "requestUri": "https://{your-service-bus-namespace}.servicebus.windows.net/{your-topic}/subscriptions/{your-service-bus-subscription}/messages/head",
    "entityType": "subscriber",
    "queueName": "QUEUE NAME IF QUEUE",
    "topicName": "TOPIC NAME IF TOPIC",
    "subscriptionName": "SUBSCRIPTION NAME"
  },
  "dataVersion": "1",
  "metadataVersion": "1"
}]

配信不能キュー イベントのスキーマも同様です。The schema for a dead letter queue event is similar:

[{
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{your-rg}/providers/Microsoft.ServiceBus/namespaces/{your-service-bus-namespace}",
  "subject": "topics/{your-service-bus-topic}/subscriptions/{your-service-bus-subscription}",
  "eventType": "Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener",
  "eventTime": "2018-02-14T05:12:53.4133526Z",
  "id": "dede87b0-3656-419c-acaf-70c95ddc60f5",
  "data": {
    "namespaceName": "YOUR SERVICE BUS NAMESPACE WILL SHOW HERE",
    "requestUri": "https://{your-service-bus-namespace}.servicebus.windows.net/{your-topic}/subscriptions/{your-service-bus-subscription}/$deadletterqueue/messages/head",
    "entityType": "subscriber",
    "queueName": "QUEUE NAME IF QUEUE",
    "topicName": "TOPIC NAME IF TOPIC",
    "subscriptionName": "SUBSCRIPTION NAME"
  },
  "dataVersion": "1",
  "metadataVersion": "1"
}]

イベントのプロパティEvent properties

イベントのトップレベルのデータを次に示します。An event has the following top-level data:

プロパティProperty TypeType 説明Description
topictopic stringstring イベント ソースの完全なリソース パス。Full resource path to the event source. このフィールドは書き込み可能ではありません。This field is not writeable. この値は Event Grid によって指定されます。Event Grid provides this value.
subjectsubject stringstring 発行元が定義したイベントの対象のパス。Publisher-defined path to the event subject.
eventTypeeventType stringstring このイベント ソース用に登録されたイベントの種類のいずれか。One of the registered event types for this event source.
eventTimeeventTime stringstring プロバイダーの UTC 時刻に基づくイベントの生成時刻。The time the event is generated based on the provider's UTC time.
idid stringstring イベントの一意識別子。Unique identifier for the event.
datadata objectobject Blob Storage イベントのデータ。Blob storage event data.
dataVersiondataVersion stringstring データ オブジェクトのスキーマ バージョン。The schema version of the data object. スキーマ バージョンは発行元によって定義されます。The publisher defines the schema version.
metadataVersionmetadataVersion stringstring イベント メタデータのスキーマ バージョン。The schema version of the event metadata. 最上位プロパティのスキーマは Event Grid によって定義されます。Event Grid defines the schema of the top-level properties. この値は Event Grid によって指定されます。Event Grid provides this value.

データ オブジェクトには、次のプロパティがあります。The data object has the following properties:

プロパティProperty TypeType 説明Description
namespaceNamenamespaceName stringstring リソースが存在する Service Bus 名前空間。The Service Bus namespace the resource exists in.
requestUrirequestUri stringstring イベントを生成している特定のキューまたはサブスクリプションの URI。The URI to the specific queue or subscription emitting the event.
entityTypeentityType stringstring イベントを生成している Service Bus エンティティの種類 (キューまたはサブスクリプション)。The type of Service Bus entity emitting events (queue or subscription).
queueNamequeueName stringstring キューをサブスクライブしている場合、アクティブなメッセージのあるキュー。The queue with active messages if subscribing to a queue. トピック/サブスクリプションを使っている場合は値 null。Value null if using topics / subscriptions.
topicNametopicName stringstring アクティブなメッセージのある Service Bus サブスクリプションが属しているトピック。The topic the Service Bus subscription with active messages belongs to. キューを使っている場合は値 null。Value null if using a queue.
subscriptionNamesubscriptionName stringstring アクティブなメッセージのある Service Bus サブスクリプション。The Service Bus subscription with active messages. キューを使っている場合は値 null。Value null if using a queue.

次の手順Next steps