Explore Azure blob storage events in Fabric Real-Time hub (preview)
This article shows how to explore Azure blob storage events in Fabric Real-Time hub. Azure blob storage events allow you to receive notifications when certain actions occur on your blobs. For example, you can receive a notification when a new blob is created, or an existing blob is modified. These events can be used to set alert on other actions or workflows, such as updating a database or sending a notification. This article provides the properties and schema for Azure blob storage events.
Note
Consuming Fabric and Azure events via eventstream or Fabric Activator is not supported if the capacity region of the eventstream or Activator is in the following regions: Germany West Central, South-Central US, West US2, West US3, West India.
View Azure blob storage events detail page
In Real-Time hub, select Azure events on the left navigation menu.
Select Azure blob storage events in the list.
You should see the Azure blob storage events detail page.
Actions
At the top of the Azure blob storage events detail page, you see the following two actions.
Create eventstream - lets you create an eventstream based on events from the selected Azure blob storage.
Set alert - lets you set an alert when an operation is done on an Azure blob storage artifact. For example, you can set an alert when a blob is created or deleted.
See what's using this category
This section shows artifacts using Azure Blob Storage events. Here are the columns and their descriptions shown in the list.
| Column | Description |
|---|---|
| Name | Name of the artifact that's using Azure Blob Storage events. |
| Type | Artifact type – Activator or Eventstream |
| Workspace | Workspace where the artifact lives. |
| Source | Name of the source (Azure Blob Storage account). |
Azure blob storage events profile
Event types
| Event type name | Description |
|---|---|
| Microsoft.Storage.BlobCreated | This event is activated when a new blob is added or when an existing blob is updated. The event is triggered by clients who use the CreateFile and FlushWithClose operations, which can be found in the Azure Data Lake Storage Gen2 REST API. |
| Microsoft.Storage.BlobDeleted | This event is activated when a blob is removed. It's triggered when clients use the DeleteFile operation that can be found in the Azure Data Lake Storage Gen2 REST API. |
| Microsoft.Storage.BlobRenamed | This event is activated when a blob undergoes a name change, particularly when users employ the RenameFile function found in the Azure Data Lake Storage Gen2 REST API. |
| Microsoft.Storage.BlobTierChanged | This event is activated when the blob access tier is modified through the SetBlobTier operation in the Blob REST API, and is triggered once the change is fully processed. |
| Microsoft.Storage.AsyncOperationInitiated | This event occurs when data is moved or copied from the archive to the hot or cool tiers. It happens when clients use the SetBlobTier API to move a blob from archive to hot or cool tiers, or when clients use the CopyBlob API to copy data from an archive tier blob to a hot or cool tier blob. |
| Microsoft.Storage.DirectoryCreated | This event is activated when a new directory is created, or a client utilizes the CreateDirectory operation provided in the Azure Data Lake Storage Gen2 REST API to form a new directory. |
| Microsoft.Storage.DirectoryRenamed | This event is activated when a directory undergoes a name change, particularly when clients utilize the RenameDirectory feature in the Azure Data Lake Storage Gen2 REST API. |
| Microsoft.Storage.DirectoryDeleted | This event is activated when a directory is removed, when customers utilize the DeleteDirectory feature present in the Azure Data Lake Storage Gen2 REST API. |
| Microsoft.Storage.BlobInventoryPolicyCompleted | This event is activated when the inventory run finishes for a policy that is specified as an inventory policy. It's also activated if the inventory run fails due to a user error before it commences, such as an erroneous policy or an absent destination container. |
| Microsoft.Storage.LifecyclePolicyCompleted | This event refers to the activation of a lifecycle management policy when its defined actions are executed. |
Schemas
An event has the following top-level data:
| Property | Type | Description | Example |
|---|---|---|---|
source |
string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. | /subscriptions/{subscription-id}/resourceGroups/Storage/providers/Microsoft.Storage/storageAccounts/my-storage-account |
subject |
string | Publisher-defined path to the event subject. | /blobServices/default/containers/my-file-system/blobs/new-file.txt |
type |
string | One of the registered event types for this event source. | Microsoft.Storage.BlobCreated |
time |
string | The time the event is generated based on the provider's UTC time. | 2017-06-26T18:41:00.9584103Z |
id |
string | Unique identifier for the event. | 00000000-0000-0000-0000-000000000000 |
data |
object | Blob storage event data. | {{Data object}} |
specversion |
string | CloudEvents schema specification version. | 1.0 |
fabricsource |
string | ID of the Fabric eventstream for the Azure Blob Storage event source. | /tenants/00000000-0000-0000-0000-000000000000/workspaces/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000 |
fabricsubject |
string | ID of the event link for the Azure Blob Storage event source. | eventLinks/00000000-0000-0000-0000-000000000000 |
The data object has the following properties:
| Property | Type | Description | Example |
|---|---|---|---|
api |
string | The operation that triggered the event. | CreateFile |
clientRequestId |
string | 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. See Log Format. |
00000000-0000-0000-0000-000000000000 |
requestId |
string | 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. See Log Format. |
00000000-0000-0000-0000-000000000000 |
eTag |
string | The value that you can use to run operations conditionally. | \"0x8D4BCC2E4835CD0\" |
contentType |
string | The content type specified for the blob. | text/plain |
contentLength |
integer | The size of the blob in bytes. | 0 |
blobType |
string | The type of blob. Valid values are either BlockBlob or PageBlob. |
BlockBlob |
contentOffset |
number | 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. |
0 |
destinationUrl |
string | 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. |
https://my-storage-account.dfs.core.windows.net/my-file-system/new-file.txt |
sourceUrl |
string | The url of the file that exists before the operation is done. For example, if a file is renamed, the sourceUrl contains the url of the original file name before the rename operation. Appears only for events triggered on blob storage accounts that have a hierarchical namespace. |
https://my-storage-account.dfs.core.windows.net/my-file-system/my-original-directory |
url |
string | The path to the blob. If the client uses a Blob REST API, then the url has this structure: |
https://myaccount.blob.core.windows.net/container01/file.txt |
recursive |
string | True to run the operation on all child directories; otherwise False. Appears only for events triggered on blob storage accounts that have a hierarchical namespace. |
true |
sequencer |
string | 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. | 00000000000004420000000000028963 |
identity |
string | A string value representing the identity associated with the event. For Secure File Transfer Protocol (SFTP), the value is the local user name. | localuser |
storageDiagnostics |
object | Diagnostic data occasionally included by the Azure Storage service. When present, event consumers should ignore it. | {{Storage diagnostic object}} |