diff --git a/sdk/identity/azure-identity/README.md b/sdk/identity/azure-identity/README.md index 802c7e371..397a81aa5 100644 --- a/sdk/identity/azure-identity/README.md +++ b/sdk/identity/azure-identity/README.md @@ -54,15 +54,15 @@ See [Credential Classes](#credential-classes) for a complete listing of availabl The `DefaultAzureCredential` attempts to authenticate via the following mechanisms, in this order, stopping when one succeeds: +![DefaultAzureCredential authentication flow][[default_azure_credential_auth_flow]] + 1. **Environment** - The `DefaultAzureCredential` will read account information specified via [environment variables](#environment-variables) and use it to authenticate. 1. **Azure CLI** - If the developer has authenticated an account via the Azure CLI `az login` command, the `DefaultAzureCredential` will authenticate with that account. 1. **Managed Identity** - If the application is deployed to an Azure host with Managed Identity enabled, the `DefaultAzureCredential` will authenticate with that account. Even though the credentials being used and their order is documented, it may change from release to release. -`DefaultAzureCredential` intends to provide a credential that "just works out of the box and without requiring any information", if only the environment is set up sufficiently for the credential to work. -Therefore, it could be simple to use, but since it uses a chain of credentials, it could be a bit complicated to diagnose if the environment setup is not sufficient. -TO help with this, `DefaultAzureCredential` code paths are instrumented with [log messages](#troubleshooting). +`DefaultAzureCredential` intends to provide a credential that "just works out of the box and without requiring any information", if only the environment is set up sufficiently for the credential to work. Therefore, it could be simple to use, but since it uses a chain of credentials, it could be a bit complicated to diagnose if the environment setup is not sufficient. To help with this, `DefaultAzureCredential` code paths are instrumented with [log messages](#troubleshooting). ## Examples @@ -181,6 +181,7 @@ Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk [azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#developer-guide [azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests [azure_sdk_cpp_development_guidelines]: https://azure.github.io/azure-sdk/cpp_introduction.html +[default_azure_credential_auth_flow]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/img/mermaidjs/DefaultAzureCredentialAuthFlow.svg [source]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/identity/azure-identity [aad_doc]: https://docs.microsoft.com/azure/active-directory/ [azure_core_library]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/core