From df6f5c910d3b2b9d913711e0e4d8c0313fb2c27a Mon Sep 17 00:00:00 2001 From: Scott Addie <10702007+scottaddie@users.noreply.github.com> Date: Thu, 12 Sep 2024 09:48:20 -0500 Subject: [PATCH] Create credential chains section in Azure Identity README (#5973) --- sdk/identity/azure-identity/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/sdk/identity/azure-identity/README.md b/sdk/identity/azure-identity/README.md index de0574ca5..897e811c5 100644 --- a/sdk/identity/azure-identity/README.md +++ b/sdk/identity/azure-identity/README.md @@ -122,16 +122,23 @@ Configuration is attempted in the above order. For example, if values for a clie ## Credential classes -### Authenticate Azure-hosted applications +### Credential chains + |Credential | Usage |-|- |`DefaultAzureCredential`|Provides a simplified authentication experience to quickly start developing applications run in Azure. |`ChainedTokenCredential`|Allows users to define custom authentication flows composing multiple credentials. + +### Authenticate Azure-hosted applications + +|Credential | Usage +|-|- |`ManagedIdentityCredential`|Authenticates the managed identity of an Azure resource. |`EnvironmentCredential`|Authenticates a service principal or user via credential information specified in environment variables. |`WorkloadIdentityCredential`|Authenticate a workload identity on Kubernetes. ### Authenticate service principals + |Credential | Usage |-|- |`AzurePipelinesCredential`|Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops) on Azure Pipelines. @@ -140,6 +147,7 @@ Configuration is attempted in the above order. For example, if values for a clie |`ClientCertificateCredential`|Authenticates a service principal [using a certificate](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). ### Authenticate via development tools + |Credential | Usage |-|- |`AzureCliCredential`|Authenticates in a development environment [with the Azure CLI](https://learn.microsoft.com/cli/azure/authenticate-azure-cli).