ClientCertificateCredential class

Пакет:

@azure/identity

Обеспечивает аутентификацию по Microsoft Entra ID с использованием сертификата, закодированного PEM, который назначается регистрации приложения. Дополнительные сведения о настройке проверки подлинности сертификатов см. здесь:

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Конструкторы

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.

Методы

getToken(string | string[], GetTokenOptions)

Аутентифицируется с помощью Microsoft Entra ID и при успешном возвращении токена доступа. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке.

Сведения о конструкторе

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

Параметры

tenantId

string

Идентификатор арендатора (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложений в клиенте.

configuration

ClientCertificatePEMCertificate

Другие параметры, необходимые, включая сертификат в кодировке PEM в виде строки. Если тип игнорируется, мы создадим значение сертификата в кодировке PEM.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

Параметры

tenantId

string

Идентификатор арендатора (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложений в клиенте.

configuration

ClientCertificatePEMCertificatePath

Другие параметры, необходимые, включая путь к сертификату в файловой системе. Если тип игнорируется, мы создадим значение пути к сертификату PEM.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Создаёт экземпляр ClientCertificateCredential с необходимыми данными для аутентификации по Microsoft Entra ID с сертификатом.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

Параметры

tenantId

string

Идентификатор арендатора (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложений в клиенте.

certificatePath

string

Путь к сертификату открытого/закрытого ключа в кодировке PEM в файловой системе. Убедитесь, что сертификат имеет формат PEM и содержит как открытый, так и закрытый ключи.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

Сведения о методе

getToken(string | string[], GetTokenOptions)

Аутентифицируется с помощью Microsoft Entra ID и при успешном возвращении токена доступа. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Параметры

scopes

string | string[]

Список областей, для которых маркер будет иметь доступ.

options

GetTokenOptions

Параметры, используемые для настройки любых запросов этой реализации TokenCredential, могут выполняться.

Возвращаемое значение

Promise<AccessToken>