Azure Event Grid の Blob Storage 用のイベント スキーマAzure Event Grid event schema for Blob storage

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

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

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

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

イベントの種類Event type 説明Description
Microsoft.Storage.BlobCreatedMicrosoft.Storage.BlobCreated BLOB が作成されたときに発生します。Raised when a blob is created.
Microsoft.Storage.BlobDeletedMicrosoft.Storage.BlobDeleted BLOB が削除されたときに発生します。Raised when a blob is deleted.

イベントの例Example event

次の例は、BlobCreated イベントのスキーマを示しています。The following example shows the schema of a blob created event:

[{
  "topic": "/subscriptions/{subscription-id}/resourceGroups/Storage/providers/Microsoft.Storage/storageAccounts/xstoretestaccount",
  "subject": "/blobServices/default/containers/testcontainer/blobs/testfile.txt",
  "eventType": "Microsoft.Storage.BlobCreated",
  "eventTime": "2017-06-26T18:41:00.9584103Z",
  "id": "831e1650-001e-001b-66ab-eeb76e069631",
  "data": {
    "api": "PutBlockList",
    "clientRequestId": "6d79dbfb-0e37-4fc4-981f-442c9ca65760",
    "requestId": "831e1650-001e-001b-66ab-eeb76e000000",
    "eTag": "0x8D4BCC2E4835CD0",
    "contentType": "text/plain",
    "contentLength": 524288,
    "blobType": "BlockBlob",
    "url": "https://example.blob.core.windows.net/testcontainer/testfile.txt",
    "sequencer": "00000000000004420000000000028963",
    "storageDiagnostics": {
      "batchId": "b68529f3-68cd-4744-baa4-3c0498ec19f0"
    }
  },
  "dataVersion": "",
  "metadataVersion": "1"
}]

同様のスキーマが BlobDeleted イベントにも使用されています。The schema for a blob deleted event is similar:

[{
  "topic": "/subscriptions/{subscription-id}/resourceGroups/Storage/providers/Microsoft.Storage/storageAccounts/xstoretestaccount",
  "subject": "/blobServices/default/containers/testcontainer/blobs/testfile.txt",
  "eventType": "Microsoft.Storage.BlobDeleted",
  "eventTime": "2017-11-07T20:09:22.5674003Z",
  "id": "4c2359fe-001e-00ba-0e04-58586806d298",
  "data": {
    "api": "DeleteBlob",
    "requestId": "4c2359fe-001e-00ba-0e04-585868000000",
    "contentType": "text/plain",
    "blobType": "BlockBlob",
    "url": "https://example.blob.core.windows.net/testcontainer/testfile.txt",
    "sequencer": "0000000000000281000000000002F5CA",
    "storageDiagnostics": {
      "batchId": "b68529f3-68cd-4744-baa4-3c0498ec19f0"
    }
  },
  "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 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
apiapi stringstring イベントのトリガーとなった操作。The operation that triggered the event.
clientRequestIdclientRequestId stringstring クライアントによって生成される opaque 値 (文字数の上限は 1 KB)。A client-generated, opaque value with a 1-KB character limit. Storage Analytics のログを有効にすると、Analytics のログに記録されます。When you have enabled storage analytics logging, it is recorded in the analytics logs.
requestIdrequestId stringstring 要求の一意の識別子。The unique identifier for the request. 要求のトラブルシューティングに使用されます。Use it for troubleshooting the request.
eTageTag stringstring この値を使用することで、条件に応じて操作を実行することができます。The value that you can use to perform operations conditionally.
contentTypecontentType stringstring BLOB に関して指定されたコンテンツの種類。The content type specified for the blob.
contentLengthcontentLength integerinteger BLOB のサイズ (単位: バイト)。The size of the blob in bytes.
blobTypeblobType stringstring BLOB の種類。The type of blob. 有効な値は "BlockBlob" または "PageBlob" です。Valid values are either "BlockBlob" or "PageBlob".
urlurl stringstring BLOB へのパス。The path to the blob.
sequencersequencer stringstring ユーザーによって制御される値。要求を追跡する際に使用できます。A user-controlled value that you can use to track requests.
storageDiagnosticsstorageDiagnostics objectobject ストレージ診断に関する情報。Information about the storage diagnostics.

次の手順Next steps