Share via

BlobChangeFeedEventData interface

  • Reference
Package:
@azure/storage-blob-changefeed

Change feed Blob storage event data.

Properties

api

The operation that triggered the event.
blobAccessTier

Access Tier of the blob.
blobType

The type of blob.
blobVersion

Version of the blob.
clientRequestId

A client-provided request id for the storage API operation. This id can be used to correlate to Azure Storage diagnostic logs using the "client-request-id" field in the logs, and can be provided in client requests using the "x-ms-client-request-id" header.
containerVersion

Version of the container the blob is in.
contentLength

The size of the blob in bytes.
contentOffset

The offset in bytes of a write operation taken at the point where the event-triggering application completed writing to the file. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
contentType

The content type specified for the blob.
destinationUrl

The url of the file that will exist after the operation completes. For example, if a file is renamed, the destinationUrl property contains the url of the new file name. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
etag

The value that you can use to perform operations conditionally.
isRecursive

True to perform the operation on all child directories; otherwise False. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
longRunningOperationInfo

AsyncOperationInfo
previousInfo

Previous info for the blob.
requestId

Service-generated request id for the storage API operation. Can be used to correlate to Azure Storage diagnostic logs using the "request-id-header" field in the logs and is returned from initiating API call in the 'x-ms-request-id' header.
sequencer

An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
snapshot

The Snapshot associated with the event.
sourceUrl

The url of the file that exists prior to the operation. For example, if a file is renamed, the sourceUrl contains the url of the original file name prior to the rename operation. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
updatedBlobProperties

Blob properties that were updated during this event.
updatedBlobTags

Blob tags that were updated during this event.
url

The path to the blob. If the client uses a Blob REST API, then the url has this structure: .blob.core.windows.net//.

Property Details

api

The operation that triggered the event.

api: string

Property Value

string

blobAccessTier

Access Tier of the blob.

blobAccessTier?: AccessTier

Property Value

AccessTier

blobType

The type of blob.

blobType: BlobType

Property Value

BlobType

blobVersion

Version of the blob.

blobVersion?: string

Property Value

string

clientRequestId

A client-provided request id for the storage API operation. This id can be used to correlate to Azure Storage diagnostic logs using the "client-request-id" field in the logs, and can be provided in client requests using the "x-ms-client-request-id" header.

clientRequestId: string

Property Value

string

containerVersion

Version of the container the blob is in.

containerVersion?: string

Property Value

string

contentLength

The size of the blob in bytes.

contentLength: number

Property Value

number

contentOffset

The offset in bytes of a write operation taken at the point where the event-triggering application completed writing to the file. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.

contentOffset?: number

Property Value

number

contentType

The content type specified for the blob.

contentType: string

Property Value

string

destinationUrl

The url of the file that will exist after the operation completes. For example, if a file is renamed, the destinationUrl property contains the url of the new file name. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.

destinationUrl?: string

Property Value

string

etag

The value that you can use to perform operations conditionally.

etag: string

Property Value

string

isRecursive

True to perform the operation on all child directories; otherwise False. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.

isRecursive?: boolean

Property Value

boolean

longRunningOperationInfo

AsyncOperationInfo

longRunningOperationInfo?: BlobOperationResult

Property Value

BlobOperationResult

previousInfo

Previous info for the blob.

previousInfo?: ChangeFeedEventPreviousInfo

Property Value

ChangeFeedEventPreviousInfo

requestId

Service-generated request id for the storage API operation. Can be used to correlate to Azure Storage diagnostic logs using the "request-id-header" field in the logs and is returned from initiating API call in the 'x-ms-request-id' header.

requestId: string

Property Value

string

sequencer

An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.

sequencer: string

Property Value

string

snapshot

The Snapshot associated with the event.

snapshot?: string

Property Value

string

sourceUrl

The url of the file that exists prior to the operation. For example, if a file is renamed, the sourceUrl contains the url of the original file name prior to the rename operation. Appears only for events triggered on blob storage accounts that have a hierarchical namespace.

sourceUrl?: string

Property Value

string

updatedBlobProperties

Blob properties that were updated during this event.

updatedBlobProperties?: UpdatedBlobProperties

Property Value

UpdatedBlobProperties

updatedBlobTags

Blob tags that were updated during this event.

updatedBlobTags?: BlobTagsChange

Property Value

BlobTagsChange

url

The path to the blob. If the client uses a Blob REST API, then the url has this structure: .blob.core.windows.net//.

url: string

Property Value

string