Skip to content

Commit d55f6d9

Browse files
authored
Update DefaultAzureCredential docs (Azure#23122)
1 parent 04f8167 commit d55f6d9

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

sdk/azidentity/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The `azidentity` module focuses on OAuth authentication with Microsoft Entra ID.
5454

5555
### DefaultAzureCredential
5656

57-
`DefaultAzureCredential` is appropriate for most apps that will be deployed to Azure. It combines common production credentials with development credentials. It attempts to authenticate via the following mechanisms in this order, stopping when one succeeds:
57+
`DefaultAzureCredential` simplifies authentication while developing applications that deploy to Azure by combining credentials used in Azure hosting environments and credentials used in local development. In production, it's better to use a specific credential type so authentication is more predictable and easier to debug. `DefaultAzureCredential` attempts to authenticate via the following mechanisms in this order, stopping when one succeeds:
5858

5959
![DefaultAzureCredential authentication flow](img/mermaidjs/DefaultAzureCredentialAuthFlow.svg)
6060

sdk/azidentity/default_azure_credential.go

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,13 @@ type DefaultAzureCredentialOptions struct {
3636
TenantID string
3737
}
3838

39-
// DefaultAzureCredential is a default credential chain for applications that will deploy to Azure.
40-
// It combines credentials suitable for deployment with credentials suitable for local development.
41-
// It attempts to authenticate with each of these credential types, in the following order, stopping
42-
// when one provides a token:
39+
// DefaultAzureCredential simplifies authentication while developing applications that deploy to Azure by
40+
// combining credentials used in Azure hosting environments and credentials used in local development. In
41+
// production, it's better to use a specific credential type so authentication is more predictable and easier
42+
// to debug.
43+
//
44+
// DefaultAzureCredential attempts to authenticate with each of these credential types, in the following order,
45+
// stopping when one provides a token:
4346
//
4447
// - [EnvironmentCredential]
4548
// - [WorkloadIdentityCredential], if environment variable configuration is set by the Azure workload

0 commit comments

Comments
 (0)