Add response headers to PeekLockResponse.

[jltorresm]

Service Bus Queue messages can have custom properties set (additionally to the standard properties set by the broker). Those are mapped to headers in the rest API.

In order to get those values we need to include the Headers as part of the response.

[demoray]

The documentation you linked indicates the properties are in a single header.

When sending a message, you can specify the following message properties. If a single message is sent or received, then these properties are contained in the BrokerProperties HTTP header in a JSON-encoded format

Instead of returning all of the headers, what are your thoughts on returning a decoded value of BrokerProperties?

[jltorresm]

I don't oppose it in principle, but that wouldn't cover the custom properties. In the final section of the docs, it mentions:

In addition to these properties, you can specify custom properties. If a single message is sent or received, each custom property is placed in its own HTTP header

Since these can have arbitrary names, I don't see how we could contain them struct. I tested custom properties on a dev queue and they are indeed set in their own headers.

[jltorresm]

Let me know your thoughts, I'm happy to rework this towards a better solution.

[jltorresm]

@microsoft-github-policy-service agree