Azure.Identity Namespace

An exception class raised for errors in authenticating client requests.

Account information relating to an authentication request.

An exception indicating that interactive authentication is required.

Authenticates by redeeming an authorization code previously obtained from Microsoft Entra ID. See https://zcusa.951200.xyz/entra/identity-platform/v2-oauth2-auth-code-flow for more information about the authorization code authentication flow.

Options used to configure the AuthorizationCodeCredential.

Defines fields exposing the well known authority hosts for the Azure Public Cloud and sovereign clouds.

Enables authentication to Microsoft Entra ID using Azure CLI to obtain an access token.

Options for configuring the AzureCliCredential.

Enables authentication to Microsoft Entra ID using Azure Developer CLI to obtain an access token.

Options for configuring the AzureDeveloperCliCredential.

Credential which authenticates using an Azure Pipelines service connection. For usage instructions, see Authenticating in Azure Pipelines with service connections.

Options used to configure the AzurePipelinesCredential.

Enables authentication to Microsoft Entra ID using Azure PowerShell to obtain an access token.

Options for configuring the AzurePowerShellCredential.

Options to customize browser view.

Provides a TokenCredential implementation which chains multiple TokenCredential implementations to be tried in order until one of the GetToken methods returns a non-default AccessToken. For more information, see ChainedTokenCredential overview.

Enables authentication of a Microsoft Entra service principal using a signed client assertion.

Options used to configure the ClientAssertionCredential.

Enables authentication of a service principal to Microsoft Entra ID using a X509 certificate that is assigned to its App Registration. More information on how to configure certificate authentication can be found at https://zcusa.951200.xyz/entra/identity-platform/certificate-credentials#register-your-certificate-with-microsoft-identity-platform.

Options used to configure the ClientCertificateCredential.

Enables authentication to Microsoft Entra ID using a client secret that was generated for an App Registration. More information on how to configure a client secret can be found at https://zcusa.951200.xyz/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application.

Options used to configure the ClientSecretCredential.

An exception indicating a TokenCredential did not attempt to authenticate and retrieve AccessToken, as its prerequisite information or state was not available.

Simplifies authentication while developing apps that deploy to Azure by combining credentials used in Azure hosting environments with credentials used in local development. In production, it's better to use something else. See Usage guidance for DefaultAzureCredential.

Attempts to authenticate with each of these credentials, in the following order, stopping when one provides a token:

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• SharedTokenCacheCredential
• VisualStudioCredential
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• InteractiveBrowserCredential

Options to configure the DefaultAzureCredential authentication flow and requests made to Azure Identity services.

A TokenCredential implementation which authenticates a user using the device code flow, and provides access tokens for that user account. For more information on the device code authentication flow see https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow.

Options to configure the DeviceCodeCredential.

Enables authentication to Microsoft Entra ID using a client secret or certificate, or as a user with a username and password.

Configuration is attempted in this order, using these environment variables:

This credential ultimately uses a ClientSecretCredential, ClientCertificateCredential, or UsernamePasswordCredential to perform the authentication using these details. Please consult the documentation of that class for more details.

Options used to configure the EnvironmentCredential.

Model factory that enables mocking for the Azure Identity library.

A TokenCredential implementation which launches the system default browser to interactively authenticate a user, and obtain an access token. The browser will only be launched to authenticate the user once, then will silently acquire access tokens through the users refresh token as long as it's valid.

Options to configure the InteractiveBrowserCredential.

Attempts authentication using a managed identity that has been assigned to the deployment environment. This authentication type works for all Azure-hosted environments that support managed identity. More information about configuring managed identities can be found at https://zcusa.951200.xyz/entra/identity/managed-identities-azure-resources/overview.

Options used to configure the ManagedIdentityCredential.

Defines the configuration for a managed identity enabled on a resource.

Enables authentication to Microsoft Entra ID using an On-Behalf-Of flow.

Authenticates using tokens in a local cache file. This is a legacy mechanism for authenticating clients using credentials provided to Visual Studio. This mechanism for Visual Studio authentication has been replaced by the VisualStudioCredential.

Options to configure the SharedTokenCacheCredential authentication.

Options controlling the storage of the token cache.

Args sent to TokenCache OnBefore and OnAfter events.

Data regarding an update of a token cache.

Exposes client options related to logging, telemetry, and distributed tracing.

Options to configure requests made to the OAUTH identity service.

Options controlling the storage of the token cache.

Enables authentication to Microsoft Entra ID using a user's username and password. If the user has MFA enabled this credential will fail to get a token throwing an AuthenticationFailedException. Also, this credential requires a high degree of trust and is not recommended outside of prototyping when more secure credentials can be used.

Options to configure the UsernamePasswordCredential.

Enables authentication to Microsoft Entra ID as the user signed in to Visual Studio Code via the 'Azure Account' extension.

It's a known issue that VisualStudioCodeCredential doesn't work with Azure Account extension versions newer than 0.9.11. A long-term fix to this problem is in progress. In the meantime, consider authenticating with AzureCliCredential.

Options for configuring the VisualStudioCodeCredential.

Enables authentication to Microsoft Entra ID using data from Visual Studio 2017 or later. See https://zcusa.951200.xyz/dotnet/azure/configure-visual-studio for more information on how to configure Visual Studio for Azure development.

Options for configuring the VisualStudioCredential.

WorkloadIdentityCredential supports Microsoft Entra Workload ID authentication on Kubernetes and other hosts supporting workload identity. Refer to Microsoft Entra Workload ID for more information.

Options used to configure the WorkloadIdentityCredential.

Details of the device code to present to a user to allow them to authenticate through the device code authentication flow.

Details related to a UnsafeTokenCacheOptions cache delegate.