Set x-ms-correlation-request-id

[jcaton-msft]

Enable a way to get or set the Http request header x-ms-correlation-request-id

The ask is to provide a mechanism to set a value in the http header when a rest full call is made to ARM by a cmdlet invocation. We need a guarantee that all the restful calls associated with any cmdlet call will set the header if specified. Thus this invocation this will impact all cmdlets available that talk with ARM. Two invocations of the same cmdlet happening “at the same time” can have distinct values in the header.
For now, we are looking to set the x-ms-correlation-request-id value in the header. Maybe they want to make it generic so we can pass a key/value pair and set other values later.

[dingmeng-xue]

@dolauli , please check if there is way to enable this feature on generated cmdlet. We don't hope to change cmdlet one by one.

[ctaggart]

@jcaton-msft, is this for instrumentation and tracing across services? According to the documentation, that is what x-ms-client-request-id is for.

x-ms-client-request-id: associated with a logical action in the client; e.g. loading the portal monitoring part may have a single client request id for many calls to ARM (e.g. load VMs + load metric definitions + load metrics)
x-ms-correlation-request-id: associated with a logical action in ARM; e.g. deleting a resource group or running a template

[dingmeng-xue]

Change this title to x-ms-client-request-id. We are considering how to set it and meet the expectation.

[ctaggart]

BTW both headers are settable my clients. The documentation was updated to explain the purpose of both:
https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#client-request-headers