ClientCertificateCredential Class

Definition

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Package:

Azure.Identity v1.13.1

Source:

ClientCertificateCredential.cs

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

TokenCredential

ClientCertificateCredential

Constructors

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

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(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.