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

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

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

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

Event Hubs は、キャプチャ ファイルが作成されたときに、種類が Microsoft.EventHub.CaptureFileCreated であるイベントを出力します。Event Hubs emits the Microsoft.EventHub.CaptureFileCreated event type when a capture file is created.

イベントの例Example event

このサンプル イベントは、ファイルがキャプチャ機能によって保存されるときに発生する Event Hubs イベントのスキーマを示しています。This sample event shows the schema of an event hubs event raised when the capture feature stores a file:

[
    {
        "topic": "/subscriptions/<guid>/resourcegroups/rgDataMigrationSample/providers/Microsoft.EventHub/namespaces/tfdatamigratens",
        "subject": "eventhubs/hubdatamigration",
        "eventType": "Microsoft.EventHub.CaptureFileCreated",
        "eventTime": "2017-08-31T19:12:46.0498024Z",
        "id": "14e87d03-6fbf-4bb2-9a21-92bd1281f247",
        "data": {
            "fileUrl": "https://tf0831datamigrate.blob.core.windows.net/windturbinecapture/tfdatamigratens/hubdatamigration/1/2017/08/31/19/11/45.avro",
            "fileType": "AzureBlockBlob",
            "partitionId": "1",
            "sizeInBytes": 249168,
            "eventCount": 1500,
            "firstSequenceNumber": 2400,
            "lastSequenceNumber": 3899,
            "firstEnqueueTime": "2017-08-31T19:12:14.674Z",
            "lastEnqueueTime": "2017-08-31T19:12:44.309Z"
        },
        "dataVersion": "",
        "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 Event Hub イベントのデータ。Event hub 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
fileUrlfileUrl stringstring キャプチャ ファイルのパス。The path to the capture file.
fileTypefileType stringstring キャプチャ ファイルのファイルの種類。The file type of the capture file.
partitionIdpartitionId stringstring シャード ID。The shard ID.
sizeInBytessizeInBytes integerinteger ファイル サイズ。The file size.
eventCounteventCount integerinteger ファイル内のイベントの数。The number of events in the file.
firstSequenceNumberfirstSequenceNumber integerinteger キューの最小のシーケンス番号。The smallest sequence number from the queue.
lastSequenceNumberlastSequenceNumber integerinteger キューの最後のシーケンス番号。The last sequence number from the queue.
firstEnqueueTimefirstEnqueueTime stringstring キューの最初の時間。The first time from the queue.
lastEnqueueTimelastEnqueueTime stringstring キューの最後の時間。The last time from the queue.

次の手順Next steps