BlobChangeFeedEventData interface
Change feed Blob storage event data.
Properties
| api | The operation that triggered the event. |
| blob |
Access Tier of the blob. |
| blob |
The type of blob. |
| blob |
Version of the blob. |
| client |
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. |
| container |
Version of the container the blob is in. |
| content |
The size of the blob in bytes. |
| content |
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. |
| content |
The content type specified for the blob. |
| destination |
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. |
| is |
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. |
| long |
AsyncOperationInfo |
| previous |
Previous info for the blob. |
| request |
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. |
| source |
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. |
| updated |
Blob properties that were updated during this event. |
| updated |
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: stringProperty Value
string
blobAccessTier
blobType
blobVersion
Version of the blob.
blobVersion?: stringProperty 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: stringProperty Value
string
containerVersion
Version of the container the blob is in.
containerVersion?: stringProperty Value
string
contentLength
The size of the blob in bytes.
contentLength: numberProperty 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?: numberProperty Value
number
contentType
The content type specified for the blob.
contentType: stringProperty 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?: stringProperty Value
string
etag
The value that you can use to perform operations conditionally.
etag: stringProperty 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?: booleanProperty Value
boolean
longRunningOperationInfo
AsyncOperationInfo
longRunningOperationInfo?: BlobOperationResultProperty Value
previousInfo
Previous info for the blob.
previousInfo?: ChangeFeedEventPreviousInfoProperty Value
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: stringProperty 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: stringProperty Value
string
snapshot
The Snapshot associated with the event.
snapshot?: stringProperty 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?: stringProperty Value
string
updatedBlobProperties
Blob properties that were updated during this event.
updatedBlobProperties?: UpdatedBlobPropertiesProperty Value
updatedBlobTags
Blob tags that were updated during this event.
updatedBlobTags?: BlobTagsChangeProperty Value
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: stringProperty Value
string
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for