Set X-Request-ID / client-request-id Header per-upload

[azure]

Set X-Request-ID / client-request-id Header per-upload

[michaeldeongreen]

@XiaoningLiu , thanks for your help. Based on your example, I was able to set custom http headers.

[XiaoningLiu]

@michaeldeongreen

If you want to customize format of the client ids, like some prefixes or suffixes, you can do it with a new policy injected to the pipeline easily.

I created a wiki page demonstrate how to customize V10 storage SDK with pipeline and polices.
https://github.com/Azure/azure-storage-js/wiki/Customize-HTTP-Pipeline-and-Policies

If you want a customized requestID field in every request method's options, it's not supported by design.
I'd like to know is there any reason for you want to do this? But you always can create different BlockBlobURL objects with different pipelines assigned to achieve this feature.

[michaeldeongreen]

@XiaoningLiu , this is a feature requested by our client.

1. We will be using SDK 10 to upload to blob storage
2. Before the upload starts, the app will call an Web API to get metadata info ie SAS, container name etc tec
3. We would like a GUID to be apart of the metadata so we can set in the client-request-id
4. Once the upload completes, many events and workflows will follow (ie EventGrid, durable functions etc etc)
5. We would like to use the client-request-id as a means to track a unique id back to the original upload

I did some research over the weekend and saw:
BlobURL.setHTTPHeaders, but the client-request-id is not a header that can be set.

I also saw:
https://docs.microsoft.com/en-us/javascript/api/%40azure/storage-blob/blobsethttpheadersoptionalparams?view=azure-node-preview
https://docs.microsoft.com/en-us/javascript/api/%40azure/storage-blob/blobsethttpheadersheaders?view=azure-node-preview

But these objects are unavailable when you create a Blob via SAS Token.

I will look into a customized pipeline.