Skip to content

Document DefaultAzureCredential breaking change in client integrations#517

Merged
IEvangelist merged 5 commits intorelease/13.2from
copilot/document-breaking-change-defaultazurecredential
Mar 6, 2026
Merged

Document DefaultAzureCredential breaking change in client integrations#517
IEvangelist merged 5 commits intorelease/13.2from
copilot/document-breaking-change-defaultazurecredential

Conversation

Copy link
Contributor

Copilot AI commented Mar 5, 2026

  • Analyze all files referencing DefaultAzureCredential across the docs
  • Review PR Refactor DefaultAzureCredential usage dotnet/aspire#14951 to understand the new credential behavior
  • Create a new common Azure doc page (azure-default-credential.mdx) explaining the default credential behavior
  • Add a breaking change section in aspire-13-2.mdx for the credential change
  • Update client integration docs that say "the DefaultAzureCredential is used" to point to the new common doc
    • azure-storage-blobs-client.mdx
    • azure-storage-queues-client.mdx
    • azure-event-hubs-client.mdx
    • azure-ai-inference-client.mdx
    • azure-app-configuration-client.mdx
    • azure-ai-search-client.mdx
    • azure-openai-client.mdx
    • azure-web-pubsub-client.mdx
    • azure-storage-datalake.mdx
    • azure-postgresql-client.mdx (in efcore/azure-postgresql)
  • Add sidebar entry for the new doc page
  • Verify changes render correctly with the dev server
Original prompt

This section details on the original issue you should resolve

<issue_title>[13.2] Document breaking change on DefaultAzureCredential in client integrations</issue_title>
<issue_description>See dotnet/aspire#14951 for more information.

Using the parameterless ctor of DefaultAzureCredential is not recommended. Instead try to detect when we are running in Azure and use Azure credentials. Fallback to using just development credentials when we can't detect we are in Azure.

See https://learn.microsoft.com/dotnet/azure/sdk/authentication/credential-chains?tabs=dac#usage-guidance-for-defaultazurecredential for more information.

Users can always provide their own to override this behavior.

This is a breaking change for anyone depending on credentials other than ManagedIdentity working in an Azure service.

If another credential is necessary in your application, you can use the following code:

builder.AddAzureBlobServiceClient(
    "blobs",
    settings =>
    {
        settings.Credential = new EnvironmentCredential();
    });

We should also update any documents in Azure that say

If no credential is configured, the DefaultAzureCredential is used

Instead it should say

If no credential is configured, a default credential is used. See [link to common Azure docs] for more information.</issue_description>

<agent_instructions>Add docs for:

  • What's new in a breaking change
  • In a common Azure document, explain the default credential that is used based on Refactor DefaultAzureCredential usage dotnet/aspire#14951
  • Update all the docs that say the DefaultAzureCrential is used and instead point them to the new doc</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Add new common doc page explaining default credential behavior
- Add breaking change section in Aspire 13.2 what's new
- Update all client integration docs to link to new credential doc

Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com>
Copilot AI changed the title [WIP] Document breaking change on DefaultAzureCredential in client integrations Document DefaultAzureCredential breaking change in client integrations Mar 5, 2026
… doc

Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com>
…ior section

Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com>
…ing credential doc

Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com>
@eerhardt eerhardt marked this pull request as ready for review March 6, 2026 15:48
@eerhardt eerhardt requested a review from IEvangelist as a code owner March 6, 2026 15:48
@IEvangelist IEvangelist merged commit 9777e3e into release/13.2 Mar 6, 2026
1 check passed
@IEvangelist IEvangelist deleted the copilot/document-breaking-change-defaultazurecredential branch March 6, 2026 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants