fix duplicate x-ms-correlation-request-id headers in list operations

[teowa]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

The go-azure-sdk list methods, which utilize ExecutePaged (https://github.com/hashicorp/go-azure-sdk/blob/6cc27674c0d8059af9f9e40958d89cb7db670600/sdk/client/client.go#L584) for pagination and subsequently correlationRequestIDMiddleware (https://github.com/hashicorp/go-azure-sdk/blob/6cc27674c0d8059af9f9e40958d89cb7db670600/sdk/client/client.go#L492) , were setting the x-ms-correlation-request-id header multiple times. This PR modifies the logic to ensure the header is set only once at the beginning of the initial request.

The error while listing Key Vault (observe from mitmproxy):

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevant documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Test in my locally built version is OK

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• fix duplicate x-ms-correlation-request-id headers in list operations

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.