ClientCertificateCredential Class

Definition

Namespace:: Azure.Identity

Assemblies:: Azure.Core.dll, Azure.Identity.dll

Assembly:: Azure.Identity.dll

Packages:: Azure.Core v1.58.0, Azure.Identity v1.17.2

Package:: Azure.Identity v1.18.0-beta.3

Source:: ClientCertificateCredential.cs

Source:: ClientCertificateCredential.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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://learn.microsoft.com/entra/identity-platform/certificate-credentials#register-your-certificate-with-microsoft-identity-platform.

public class ClientCertificateCredential : Azure.Core.TokenCredential

type ClientCertificateCredential = class
 inherit TokenCredential

Public Class ClientCertificateCredential
Inherits TokenCredential

Inheritance: Object

AuthenticationTokenProvider

TokenCredential
ClientCertificateCredential

Constructors

Name	Description
ClientCertificateCredential()	Protected constructor for mocking.
ClientCertificateCredential(String, String, String, ClientCertificateCredentialOptions)	Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
ClientCertificateCredential(String, String, String)	Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
ClientCertificateCredential(String, String, X509Certificate2, ClientCertificateCredentialOptions)	Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
ClientCertificateCredential(String, String, X509Certificate2)	Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.

Methods

Name	Description
CreateTokenOptions(IReadOnlyDictionary<String,Object>)	Creates a new instance of GetTokenOptions using the provided `properties`. (Inherited from TokenCredential)
GetToken(GetTokenOptions, CancellationToken)	Gets an AuthenticationToken for the provided `properties`. (Inherited from TokenCredential)
GetToken(TokenRequestContext, CancellationToken)	Obtains a token from Microsoft Entra ID, using the specified X509 certificate to authenticate. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances to optimize cache effectiveness.
GetTokenAsync(GetTokenOptions, CancellationToken)	Gets an AuthenticationToken for the provided `properties`. (Inherited from TokenCredential)
GetTokenAsync(TokenRequestContext, CancellationToken)	Obtains a token from Microsoft Entra ID, using the specified X509 certificate to authenticate. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances to optimize cache effectiveness.

Applies to

Feedback

Was this page helpful?