Event Hubs Archive, what’s the new naming convention


We have listened to your wonderful feedback on EH Archive blob naming conventions and have now designed a simpler naming pattern, while at the same time capturing the essentials required for identifying the source of the archived blob.

 So, what is the blob-naming pattern then?

In short, it could be any name that Azure Storage allows if it has the following required parameters – {namespace}, {EventHub}, {PartitionId}, {Year}, {Month},{Day},{Hour},{Minute} and {Second} in any order and with or without any delimiters support for Azure Storage Blob. We need all these parameters to ensure the uniqueness of the files created.

 The portal now features a text box that validates that these required parameters exist when you compose an Azure Storage Blob name pattern that fits your needs. As you type these parameters, it also evaluates them for your event hub, namespace and partition Id so that you have a realistic example of a blob name.

figure-1-sample-file-name-formats

Figure 1: Select from the sample file format specified

figure-2-template-specifier

Figure 2: Build your own custom file name

figure-3-message-bubble

Figure 3: The message bubble guiding you to build the file name

Once you have chosen the format for your file names, a sample is displayed in the portal as shown below

figure-4-example-filename

Figure 4: The format you have chosen and an example

Some file naming examples could be:

 These mandatory parameters are case-insensitive. In addition, they can appear in any order. E.g. myuniqueblobpattern/{Namespace}/{EventHub}/{PartitionId}/{year}{month}{date}/{hour}{minute}{second}/

 Or

 {year}{month}{date}/{hour}{minute}{second}/myuniqueblobpattern/{Namespace}/{EventHub}/{PartitionId}

 Go ahead and type away different combinations on the text box!

We would love to hear your feedback on these improvements!

 

Comments (2)

  1. Alex G says:

    Very useful to be able to customize this format.
    Is it possible to set the format when creating the Event Hub through code?
    I can see the format being stored in a private field of the ArchiveDestination object, but can’t see a way to set that through code.
    Thanks

    1. You can make a REST api call as below

      “ArchiveDescription”:{
      “enabled”:”[parameters(‘archiveEnabled’)]”,
      “encoding”:”[parameters(‘archiveEncodingFormat’)]”,
      “intervalInSeconds”:”[parameters(‘archiveTime’)]”,
      “sizeLimitInBytes”:”[parameters(‘archiveSize’)]”,
      “destination”:{
      “name”:”EventHubArchive.AzureBlockBlob”,
      “properties”:{
      “StorageAccountResourceId”:”[parameters(‘destinationStorageAccountResourceId’)]”,
      “BlobContainer”:”[parameters(‘blobContainerName’)]”,
      “ArchiveNameFormat”:”[parameters(‘archiveNameFormat’)]”
      }
      }
      }
      Hope that helps!

Skip to main content