Aracılığıyla paylaş

EnvironmentCredential class

Paket:
@azure/identity

İstemci parolası veya sertifika kullanarak Microsoft Entra Kimliği'nde kimlik doğrulamasını etkinleştirir.

Oluşturucular

EnvironmentCredential(EnvironmentCredentialOptions)

EnvironmentCredential sınıfının bir örneğini oluşturur ve kullanılabilir ortam değişkenlerine bağlı olarak hangi kimlik bilgilerinin kullanılacağına karar verir.

Gerekli ortam değişkenleri:

  • AZURE_TENANT_ID: Microsoft Entra kiracısı (dizin) kimliği.
  • AZURE_CLIENT_ID: Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.

AZURE_TENANT_ID ayarlanıyorsa, ek olarak izin verilen kiracıları da ayarlayabilirsiniz

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Çok kiracılı uygulamalar için, kimlik bilgilerinin tek bir noktalı virgülle ayrılmış dizeyle belirteçleri alabileceği ek kiracıları belirtir. Tüm kiracılara izin vermek için * kullanın.

İstemci kimlik bilgisi kimlik doğrulaması için kullanılan ortam değişkenleri:

  • AZURE_CLIENT_SECRET: Uygulama Kaydı için oluşturulan bir istemci gizli dizisi.
  • AZURE_CLIENT_CERTIFICATE_PATH: İstemci gizli dizisi yerine kimlik doğrulaması sırasında kullanılacak pem sertifikasının yolu.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: Sertifika dosyası için (isteğe bağlı) parola.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (isteğe bağlı), sertifika zincirinin konu adı /veren tabanlı kimlik doğrulamasını desteklemek için x5c üst bilgisinde ayarlanması gerektiğini belirtir.

Kullanıcı adı ve parola kimlik doğrulaması, çok faktörlü kimlik doğrulamasını (MFA) desteklemediğinden kullanım dışıdır. Daha fazla bilgi için bkz. https://aka.ms/azsdk/identity/mfa. Kullanıcılar bu kimlik doğrulama yöntemi için ortam değişkenleri sağlamaya devam edebilir:

  • AZURE_USERNAME: Kimlik doğrulaması için kullanıcı adı.
  • AZURE_PASSWORD: Kimlik doğrulaması için parola.

Kimlik doğrulamasını gerçekleştirmek için gereken ortam değişkenleri eksikse, CredentialUnavailableError oluşturulur. Kimlik doğrulaması başarısız olursa veya bilinmeyen bir hata varsa AuthenticationError oluşturulur.

Yöntemler

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.

Oluşturucu Ayrıntıları

EnvironmentCredential(EnvironmentCredentialOptions)

EnvironmentCredential sınıfının bir örneğini oluşturur ve kullanılabilir ortam değişkenlerine bağlı olarak hangi kimlik bilgilerinin kullanılacağına karar verir.

Gerekli ortam değişkenleri:

  • AZURE_TENANT_ID: Microsoft Entra kiracısı (dizin) kimliği.
  • AZURE_CLIENT_ID: Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.

AZURE_TENANT_ID ayarlanıyorsa, ek olarak izin verilen kiracıları da ayarlayabilirsiniz

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Çok kiracılı uygulamalar için, kimlik bilgilerinin tek bir noktalı virgülle ayrılmış dizeyle belirteçleri alabileceği ek kiracıları belirtir. Tüm kiracılara izin vermek için * kullanın.

İstemci kimlik bilgisi kimlik doğrulaması için kullanılan ortam değişkenleri:

  • AZURE_CLIENT_SECRET: Uygulama Kaydı için oluşturulan bir istemci gizli dizisi.
  • AZURE_CLIENT_CERTIFICATE_PATH: İstemci gizli dizisi yerine kimlik doğrulaması sırasında kullanılacak pem sertifikasının yolu.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: Sertifika dosyası için (isteğe bağlı) parola.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (isteğe bağlı), sertifika zincirinin konu adı /veren tabanlı kimlik doğrulamasını desteklemek için x5c üst bilgisinde ayarlanması gerektiğini belirtir.

Kullanıcı adı ve parola kimlik doğrulaması, çok faktörlü kimlik doğrulamasını (MFA) desteklemediğinden kullanım dışıdır. Daha fazla bilgi için bkz. https://aka.ms/azsdk/identity/mfa. Kullanıcılar bu kimlik doğrulama yöntemi için ortam değişkenleri sağlamaya devam edebilir:

  • AZURE_USERNAME: Kimlik doğrulaması için kullanıcı adı.
  • AZURE_PASSWORD: Kimlik doğrulaması için parola.

Kimlik doğrulamasını gerçekleştirmek için gereken ortam değişkenleri eksikse, CredentialUnavailableError oluşturulur. Kimlik doğrulaması başarısız olursa veya bilinmeyen bir hata varsa AuthenticationError oluşturulur.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parametreler

options
EnvironmentCredentialOptions

Kimlik doğrulama isteğinde bulunan istemciyi yapılandırma seçenekleri.

Yöntem Ayrıntıları

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.

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

Parametreler

scopes

string | string[]

Belirtecin erişeceği kapsamların listesi.

options
GetTokenOptions

İsteğe bağlı parametreler. Bkz. getTokenOptions.

Döndürülenler

Promise<AccessToken>