Aracılığıyla paylaş

DeviceCodeCredential class

Paket:
@azure/identity

Kullanıcının https://microsoft.com/devicelogingirebileceği bir cihaz kodu kullanarak Microsoft Entra Id kimlik doğrulaması sağlar.

Oluşturucular

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra Id ile cihaz kodu yetkilendirme akışını başlatmak için gereken ayrıntıları içeren bir DeviceCodeCredential örneği oluşturur.

Bir ileti günlüğe kaydedilir ve kullanıcılara https://microsoft.com/devicelogin

Geliştiriciler özel bir userPromptCallbackgeçirerek bu iletinin nasıl gösterileceğini yapılandırabilir:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

Yöntemler

authenticate(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Belirteç sessizce alınamazsa, bu yöntem her zaman kullanıcı için bir sınama oluşturur.
getToken(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Kullanıcı disableAutomaticAuthenticationseçeneğini sağladıysa, belirteç sessizce alınamadıktan sonra, bu yöntem belirteci almak için kullanıcı etkileşimi istemeye çalışmaz.

Oluşturucu Ayrıntıları

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra Id ile cihaz kodu yetkilendirme akışını başlatmak için gereken ayrıntıları içeren bir DeviceCodeCredential örneği oluşturur.

Bir ileti günlüğe kaydedilir ve kullanıcılara https://microsoft.com/devicelogin

Geliştiriciler özel bir userPromptCallbackgeçirerek bu iletinin nasıl gösterileceğini yapılandırabilir:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

Parametreler

options
DeviceCodeCredentialOptions

Kimlik doğrulama isteklerini yapan istemciyi yapılandırma seçenekleri.

Yöntem Ayrıntıları

authenticate(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Belirteç sessizce alınamazsa, bu yöntem her zaman kullanıcı için bir sınama oluşturur.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

Parametreler

scopes

string | string[]

Belirtecin erişeceği kapsamların listesi.

options
GetTokenOptions

Bu TokenCredential uygulamasının gerçekleştirebileceği istekleri yapılandırmak için kullanılan seçenekler.

Döndürülenler

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Kullanıcı disableAutomaticAuthenticationseçeneğini sağladıysa, belirteç sessizce alınamadıktan sonra, bu yöntem belirteci almak için kullanıcı etkileşimi istemeye çalışmaz.

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

Parametreler

scopes

string | string[]

Belirtecin erişeceği kapsamların listesi.

options
GetTokenOptions

Bu TokenCredential uygulamasının gerçekleştirebileceği istekleri yapılandırmak için kullanılan seçenekler.

Döndürülenler

Promise<AccessToken>