Aracılığıyla paylaş

@azure/identity package

  • Başvuru

Sınıflar

AggregateAuthenticationError

errorsChainedTokenCredential içindeki kimlik bilgilerinden kimlik doğrulaması hataları için AuthenticationError örneğini içeren bir dizi sağlar.
AuthenticationError

Azure Active Directory ile kimlik doğrulamasının başarısız olmasıyla ilgili ayrıntıları sağlar. bu errorResponse alan, belirli hata hakkında daha fazla ayrıntı içerir.
AuthenticationRequiredError

Belirteci sessizce almaya çalıştıktan sonra kimlik doğrulamasını zorunlu kılmak için kullanılan hata.
AuthorizationCodeCredential

kimlik doğrulamasının, Microsoft Entra ID belgelerinde daha ayrıntılı olarak açıklanan yetkilendirme kodu akışı aracılığıyla elde edilen yetkilendirme kodunu kullanarak Microsoft Entra ID sağlar:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

Bu kimlik bilgisi, Azure CLI ('az') komut satırı aracı aracılığıyla oturum açmış durumdaki kullanıcı oturum açma bilgilerini kullanır. Bunu yapmak için kullanıcı erişim belirtecini okur ve "az account get-access-token" Azure CLI komutuyla süresi dolar.
AzureDeveloperCliCredential

Azure Developer CLI, geliştiricilerin Azure'da kaynak oluşturmasına, yönetmesine ve dağıtmasına olanak tanıyan bir komut satırı arabirimi aracıdır. Azure CLI'nın üzerine kurulmuştur ve Azure geliştiricilerine özgü ek işlevler sağlar. Kullanıcıların Microsoft Entra ID karşı kullanıcı ve/veya hizmet sorumlusu olarak kimlik doğrulaması yapmasına olanak tanır. AzureDeveloperCliCredential bir geliştirme ortamında kimlik doğrulaması yapar ve Azure Developer CLI oturum açmış kullanıcı veya hizmet sorumlusu adına bir belirteç alır. Kullanıcının veya hizmet sorumlusunun oturum açtığı Azure Developer CLI işlevi görür ve Microsoft Entra ID karşı uygulamanın kimliğini doğrulamak için altında bir Azure CLI komutu yürütür.

AzureDeveloperCliCredential'ı yapılandırma

Bu kimlik bilgilerini kullanmak için geliştiricinin aşağıdaki komutlardan birini kullanarak Azure Developer CLI yerel olarak kimlik doğrulaması yapması gerekir:

  1. Kullanıcı olarak etkileşimli olarak kimlik doğrulaması yapmak için Azure Developer CLI'de "azd auth login" komutunu çalıştırın.
  2. Hizmet sorumlusu olarak kimlik doğrulaması yapmak için "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" komutunu çalıştırın.

Kuruluşunuzdaki yenileme belirteci geçerliliğine bağlı olarak bu işlemi belirli bir süre sonra tekrarlamanız gerekebilir. Genellikle yenileme belirteci geçerlilik süresi birkaç haftadan birkaç aya kadardır. AzureDeveloperCliCredential yeniden oturum açmanızı ister.
AzurePowerShellCredential

Bu kimlik bilgisi, Azure PowerShell modülünde oturum açmış durumdaki kullanıcı bilgilerini kullanır. Bunu yapmak için kullanıcı erişim belirtecini okur ve Azure PowerShell komutuyla süresi dolarGet-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

getToken yöntemlerinden biri bir erişim belirteci döndürene kadar birden çok TokenCredential uygulamanın sırayla denenmesi için olanak tanır.
ClientAssertionCredential

JWT onayıyla hizmet sorumlusu kimliğini doğrular.
ClientCertificateCredential

Uygulama Kaydına atanan PEM kodlu sertifikayı kullanarak Microsoft Entra ID kimlik doğrulamasını etkinleştirir. Sertifika kimlik doğrulamasını yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz:

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

Uygulama Kaydı için oluşturulan bir istemci gizli dizisini kullanarak Microsoft Entra ID kimlik doğrulamasını etkinleştirir. İstemci gizli dizisini yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

Bu, zincirlenmiş bir kimlik bilgisi içinde denenen kimlik bilgilerinin kimlik bilgisi olarak kullanılamadığını belirtir. Bunu zinciri durdurması gereken bir hata olarak işlemek yerine yakalanıyor ve zincir devam ediyor
DefaultAzureCredential

Azure SDK kullanan çoğu uygulama için çalışması gereken varsayılan chainedTokenCredential yapılandırması sağlar.
DeviceCodeCredential

Kullanıcının içine girebileceği https://microsoft.com/deviceloginbir cihaz kodu kullanarak Microsoft Entra ID kimlik doğrulamasını etkinleştirir.
EnvironmentCredential

İstemci gizli dizisi veya sertifika kullanarak ya da kullanıcı adı ve parolası olan bir kullanıcı olarak kimlik doğrulamasının Microsoft Entra ID sağlar.
InteractiveBrowserCredential

Etkileşimli oturum açma akışını kullanarak web tarayıcısının içinde Microsoft Entra ID kimlik doğrulamasını etkinleştirir.
ManagedIdentityCredential

Dağıtım ortamında kullanılabilen bir yönetilen kimlik kullanarak kimlik doğrulamayı dener. Bu kimlik doğrulama türü Azure VM'lerinde, App Service örneklerinde, Azure İşlevleri uygulamalarında, Azure Kubernetes Services'te, Azure Service Fabric örneklerinde ve Azure Cloud Shell içinde çalışır.

Yönetilen kimlikleri yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Kimlik doğrulamasının AdLarına akışını kullanarak Microsoft Entra ID sağlar.
UsernamePasswordCredential

Kullanıcının kullanıcı adı ve parolası ile Microsoft Entra ID kimlik doğrulamasını etkinleştirir. Bu kimlik bilgisi yüksek düzeyde güven gerektirdiğinden, bunu yalnızca diğer, daha güvenli kimlik bilgileri türleri kullanılamadığında kullanmalısınız.
VisualStudioCodeCredential

'Azure Hesabı' VSCode uzantısı tarafından sağlanan kimlik bilgilerini kullanarak Azure'a bağlanır. Kullanıcı uzantı aracılığıyla oturum açtıktan sonra, bu kimlik bilgisi uzantı tarafından önbelleğe alınan yenileme belirtecini paylaşabilir.

Bu kimlik bilgilerinin 0.9.11'den yeni Azure Hesabı uzantısı sürümleriyle çalışmaması bilinen bir sorundur. Bu soruna uzun vadeli bir düzeltme devam ediyor. Bu arada AzureCliCredential ile kimlik doğrulamayı göz önünde bulundurun.
WorkloadIdentityCredential

İş Yükü Kimliği kimlik doğrulaması, sanal makinelerde (VM) çalışan uygulamaların hizmet sorumlusuna veya yönetilen kimliğe gerek kalmadan diğer Azure kaynaklarına erişmesine olanak tanıyan bir Azure özelliğidir. İş Yükü Kimliği kimlik doğrulamasıyla, uygulamalar paylaşılan hizmet sorumlusu veya yönetilen kimlik kullanmak yerine kendi kimliklerini kullanarak kimliklerini doğrular. İş Yükü Kimliği kimlik doğrulaması, Azure tarafından otomatik olarak oluşturulan ve VM'de güvenli bir şekilde depolanan Hizmet Hesabı Kimlik Bilgileri (SAC) kavramını kullanır. İş Yükü Kimliği kimlik doğrulamasını kullanarak, her vm'de her uygulama için hizmet sorumlularını veya yönetilen kimlikleri yönetme ve döndürme gereksinimini önleyebilirsiniz. Ayrıca, SAC'ler otomatik olarak oluşturulduğundan ve Azure tarafından yönetildiğinden, hassas kimlik bilgilerini depolama ve güvenliğini sağlama konusunda endişelenmeniz gerekmez. WorkloadIdentityCredential, Azure Kubernetes'te Microsoft Entra İş Yükü Kimliği kimlik doğrulamasını destekler ve Azure Kubernetes ortamında bulunan SAC'leri kullanarak belirteç alır. Daha fazla bilgi için Microsoft Entra İş Yükü Kimliği bakın.

Arabirimler

AccessToken

Süre sonu olan bir erişim belirtecini temsil eder.
AuthenticationRecord

Önbellekte önbelleğe alınmış belirteçleri bulmak için kullanılacak kayıt.
AuthenticationRequiredErrorOptions

AuthenticationRequiredError için isteğe bağlı parametreler
AuthorityValidationOptions

Kimlik kitaplığının Microsoft Entra ID kimlik doğrulama istekleri sırasında yetki doğrulamasını nasıl yaptığını yapılandırmaya yönelik seçenekler sağlar.
AuthorizationCodeCredentialOptions

AuthorizationCodeCredential seçenekleri
AzureCliCredentialOptions

AzureCliCredential seçenekleri
AzureDeveloperCliCredentialOptions

AzureDeveloperCliCredential seçenekleri
AzurePowerShellCredentialOptions

AzurePowerShellCredential seçenekleri
BrokerAuthOptions

WAM Aracısı Kimlik Doğrulamasını desteklemek için InteractiveBrowserCredential yapılandırma seçenekleri.
BrokerDisabledOptions

WAM aracısı kimlik doğrulaması devre dışı bırakıldığında parametreler.
BrokerEnabledOptions

WAM aracısı kimlik doğrulaması etkinleştirildiğinde parametreler.
BrowserCustomizationOptions

Tarayıcı özelleştirmesi için paylaşılan yapılandırma seçenekleri
ClientAssertionCredentialOptions

ClientAssertionCredential seçenekleri
ClientCertificateCredentialOptions

ClientCertificateCredential sınıfı için isteğe bağlı parametreler.
ClientCertificatePEMCertificate

ClientCertificateCredential için pem sertifikasının dize içeriğiyle gerekli yapılandırma seçenekleri
ClientCertificatePEMCertificatePath

ClientCertificateCredential için pem sertifikasının yolu ile gerekli yapılandırma seçenekleri.
ClientSecretCredentialOptions

ClientSecretCredential sınıfı için isteğe bağlı parametreler.
CredentialPersistenceOptions

Kalıcı belirteç önbelleğe almayı destekleyen kimlik bilgileri için paylaşılan yapılandırma seçenekleri.
DefaultAzureCredentialClientIdOptions

DefaultAzureCredential sınıfını yapılandırma seçenekleri sağlar. Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon managedIdentityClientId destekler ve desteklemez managedIdentityResourceId.
DefaultAzureCredentialOptions

DefaultAzureCredential sınıfını yapılandırma seçenekleri sağlar.
DefaultAzureCredentialResourceIdOptions

DefaultAzureCredential sınıfını yapılandırma seçenekleri sağlar. Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon managedIdentityResourceId destekler ve desteklemez managedIdentityClientId.
DeviceCodeCredentialOptions

Node.js için InteractiveBrowserCredential sınıfının seçeneklerini tanımlar.
DeviceCodeInfo

Kodun girilmesi gereken kullanıcı kodunu ve doğrulama URI'sini sağlar. Ayrıca kullanıcıya görüntülenecek ve bu ayrıntıları içeren bir yönerge içeren bir ileti de sağlar.
EnvironmentCredentialOptions

Kullanılabilir ortam değişkenlerine bağlı olarak kimlik doğrulamasının Microsoft Entra ID sağlar. EnvironmentCredential sınıfı için seçenekleri tanımlar.
ErrorResponse

Diğer ayrıntılar için resmi belgelere bakın:

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

NOT: Bu belge v1 OAuth desteğine yöneliktir, ancak aynı hata yanıtı ayrıntıları v2 için de geçerlidir.
GetBearerTokenProviderOptions

Belirteç sağlayıcısını yapılandırma seçenekleri.
GetTokenOptions

TokenCredential.getToken seçeneklerini tanımlar.
InteractiveBrowserCredentialInBrowserOptions

InteractiveBrowserCredential sınıfı için ortak seçenekleri tanımlar.
InteractiveBrowserCredentialNodeOptions

InteractiveBrowserCredential sınıfı için ortak seçenekleri tanımlar.
InteractiveCredentialOptions

Kullanıcı etkileşimi gerektiren Kimlik kimlik bilgileri için ortak oluşturucu seçenekleri.
ManagedIdentityCredentialClientIdOptions

ManagedIdentityCredential oluşturucusunun gönderme seçenekleri. Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon clientId destekler ve desteklemez resourceId.
ManagedIdentityCredentialResourceIdOptions

ManagedIdentityCredential oluşturucusunun gönderme seçenekleri. Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon resourceId destekler ve desteklemez clientId.
MultiTenantTokenCredentialOptions

Ek olarak izin verilen kiracılara izin veren çok kiracılı uygulamalar için seçenekler.
OnBehalfOfCredentialCertificateOptions

Bir sertifikayla OnBehalfOfCredential kimliğini doğrulamak için parametreleri tanımlar.
OnBehalfOfCredentialSecretOptions

Bir gizli dizi ile OnBehalfOfCredential kimliğini doğrulamak için parametreleri tanımlar.
TokenCachePersistenceOptions

Kimlik kimlik bilgilerinde belirteç önbelleği kalıcılığını etkinleştiren parametreler.
TokenCredential

Kimlik doğrulama belirteci sağlayabilen bir kimlik bilgilerini temsil eder.
TokenCredentialOptions

Kimlik kitaplığının Microsoft Entra ID için kimlik doğrulama isteklerini nasıl yaptığını yapılandırmaya yönelik seçenekler sağlar.
UsernamePasswordCredentialOptions

UsernamePasswordCredential sınıfı için seçenekleri tanımlar.
VisualStudioCodeCredentialOptions

Visual Studio Code kimlik bilgilerini yapılandırma seçenekleri sağlar.
WorkloadIdentityCredentialOptions

WorkloadIdentityCredential seçenekleri

Tür Diğer Adları

BrokerOptions

InteractiveBrowserCredential içinde WAM aracısı kimlik doğrulamasını etkinleştiren parametreler.
BrowserLoginStyle

(Yalnızca tarayıcı özelliği) Kimlik doğrulama akışında kullanılacak "oturum açma stili":

  • "redirect", kullanıcıyı kimlik doğrulama sayfasına yönlendirir ve kimlik doğrulaması tamamlandıktan sonra yeniden sayfaya yönlendirir.
  • "açılan pencere", yeniden yönlendirme akışının başlatıldığı yeni bir tarayıcı penceresi açar. Kullanıcının mevcut tarayıcı penceresi geçerli sayfadan ayrılmıyor
ClientCertificateCredentialPEMConfiguration

ClientCertificateCredential için pem sertifikasının dize içeriği veya PEM sertifikasının yolu ile gerekli yapılandırma seçenekleri.
DeviceCodePromptCallback

Kullanıcıya kimlik doğrulama ayrıntılarını görüntülemek amacıyla DeviceCodeCredential'a geçirilecek bir geri çağırmanın imzasını tanımlar.
IdentityPlugin

Eklenti bağlamını kabul eden bir işlev olan Azure Identity eklentisinin türü.
OnBehalfOfCredentialOptions

OnBehalfOfCredential sınıfı için isteğe bağlı parametreler.

Numaralandırmalar

AzureAuthorityHosts

Bilinen Azure yetkili konaklarının listesi

İşlevler

deserializeAuthenticationRecord(string)

Daha önce seri hale getirilmiş bir kimlik doğrulama kaydını bir dizeden bir nesneye seri durumdan kaldırır.

Giriş dizesi aşağıdaki özellikleri içermelidir:

  • "yetkili"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "kullanıcı adı"
  • "sürüm"

Aldığımız sürüm desteklenmiyorsa bir hata oluşur.

Şu anda tek kullanılabilir sürüm şudur: Kimlik doğrulama kaydı seri hale getirildiğinde her zaman ayarlanan "1.0".
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Taşıyıcı belirteci sağlayan bir geri çağırma döndürür. Örneğin taşıyıcı belirteci bir isteğin kimliğini doğrulamak için aşağıdaki gibi kullanılabilir:

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

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);
getDefaultAzureCredential()

DefaultAzureCredential öğesinin yeni bir örneğini döndürür.
serializeAuthenticationRecord(AuthenticationRecord)

Bir dizede seri AuthenticationRecord hale getirme.

Serileştirilmiş kimlik doğrulama kaydının çıkışı aşağıdaki özellikleri içerir:

  • "yetkili"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "kullanıcı adı"
  • "sürüm"

Daha sonra bu dizeyi seri hale getirilmiş AuthenticationRecordbir dizeye dönüştürmek için lütfen dışarı aktarılan işlevini deserializeAuthenticationRecord()kullanın.
useIdentityPlugin(IdentityPlugin)

Ek işlevlerle Azure Kimliği'nin kapsamını genişletme. Eklenti paketinden bir eklenti geçirin, örneğin:

  • @azure/identity-cache-persistence: kalıcı belirteç önbelleğe alma sağlar
  • @azure/identity-vscode: bağımlılıklarını VisualStudioCodeCredential sağlar ve etkinleştirir

Örnek:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

İşlev Ayrıntıları

deserializeAuthenticationRecord(string)

Daha önce seri hale getirilmiş bir kimlik doğrulama kaydını bir dizeden bir nesneye seri durumdan kaldırır.

Giriş dizesi aşağıdaki özellikleri içermelidir:

  • "yetkili"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "kullanıcı adı"
  • "sürüm"

Aldığımız sürüm desteklenmiyorsa bir hata oluşur.

Şu anda tek kullanılabilir sürüm şudur: Kimlik doğrulama kaydı seri hale getirildiğinde her zaman ayarlanan "1.0".

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parametreler

serializedRecord

string

Kimlik doğrulama kaydı daha önce dize olarak seri hale getirildi.

Döndürülenler

AuthenticationRecord

AuthenticationRecord.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Taşıyıcı belirteci sağlayan bir geri çağırma döndürür. Örneğin taşıyıcı belirteci bir isteğin kimliğini doğrulamak için aşağıdaki gibi kullanılabilir:

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

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>

Parametreler

credential
TokenCredential

İsteğin kimliğini doğrulamak için kullanılan kimlik bilgisi.

scopes

string | string[]

Taşıyıcı belirteci için gereken kapsamlar.

options
GetBearerTokenProviderOptions

Belirteç sağlayıcısını yapılandırma seçenekleri.

Döndürülenler

() => Promise<string>

taşıyıcı belirteci sağlayan bir geri çağırma.

getDefaultAzureCredential()

DefaultAzureCredential öğesinin yeni bir örneğini döndürür.

function getDefaultAzureCredential(): TokenCredential

Döndürülenler

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Bir dizede seri AuthenticationRecord hale getirme.

Serileştirilmiş kimlik doğrulama kaydının çıkışı aşağıdaki özellikleri içerir:

  • "yetkili"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "kullanıcı adı"
  • "sürüm"

Daha sonra bu dizeyi seri hale getirilmiş AuthenticationRecordbir dizeye dönüştürmek için lütfen dışarı aktarılan işlevini deserializeAuthenticationRecord()kullanın.

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parametreler

record
AuthenticationRecord

Döndürülenler

string

useIdentityPlugin(IdentityPlugin)

Ek işlevlerle Azure Kimliği'nin kapsamını genişletme. Eklenti paketinden bir eklenti geçirin, örneğin:

  • @azure/identity-cache-persistence: kalıcı belirteç önbelleğe alma sağlar
  • @azure/identity-vscode: bağımlılıklarını VisualStudioCodeCredential sağlar ve etkinleştirir

Örnek:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

Parametreler

plugin
IdentityPlugin

kaydedilecek eklenti