@azure/identity package
Sınıflar
| AggregateAuthenticationError |
|
| AuthenticationError |
Azure Active Directory ile kimlik doğrulama başarısızlığı hakkında detaylar sunar.
|
| AuthenticationRequiredError |
Belirteci sessizce almaya çalıştıktan sonra kimlik doğrulamasını zorlamak için kullanılan hata. |
| AuthorizationCodeCredential |
Yetkilendirme kodu akışıyla elde edilen yetkilendirme kodu kullanılarak Microsoft Entra ID'ye kimlik doğrulamasını sağlar; bu kod Microsoft Entra ID dokümantasyonunda daha ayrıntılı olarak açıklanmıştır: https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow |
| AzureCliCredential |
Bu kimlik belgesi, Azure CLI ('az') komut satırı aracı aracılığıyla şu anda oturum açılmış kullanıcı giriş bilgilerini kullanacaktır. Bunu yapmak için, kullanıcı erişim token'ını okuyor ve Azure CLI komutu "az account get-access-token" ile sona erer. |
| AzureDeveloperCliCredential |
Azure Developer CLI, geliştiricilerin Azure'da kaynaklar oluşturmasına, yönetmesine ve dağıtmasına olanak tanıyan komut satırı arayüzü aracıdır. Azure CLI'nin üzerine inşa edilmiş ve Azure geliştiricilerine özgü ek işlevsellik sağlar. Kullanıcıların Microsoft Entra ID karşısında bir kullanıcı ve/veya hizmet prensibi olarak kimlik doğrulamasına olanak tanır. AzureDeveloperCliCredential, bir geliştirme ortamında kimlik doğrulamasını sağlar ve Azure Developer CLI'da giriş yapmış kullanıcı veya hizmet yöneticisi adına bir token edinir. Azure Developer CLI'si kullanıcı veya hizmet prensibi olarak giriş yapar ve uygulamanın Microsoft Entra ID'sine karşı doğrulaması için altında bir Azure CLI komutu çalıştırır. AzureDeveloperCliCredential'ı yapılandırmaBu kimlik bilgisini kullanmak için geliştiricinin Azure Developer CLI'da aşağıdaki komutlardan birini kullanarak yerel olarak kimlik doğrulaması yapması gerekir:
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ç hafta ile birkaç ay sürer. AzureDeveloperCliCredential yeniden oturum açmanızı ister. |
| AzurePipelinesCredential |
Bu kimlik bilgisi, Azure Pipelines'te hizmet bağlantılarıyla iş yükü kimlik federasyonu için bir kurulum olarak kullanılmak üzere tasarlanmıştır. |
| AzurePowerShellCredential |
Bu kimlik belgesi, Azure PowerShell modülünden şu anda giriş yapmış kullanıcı bilgilerini kullanacaktır. Bunu yapmak için, kullanıcı erişim token'ı okuyor ve |
| ChainedTokenCredential |
GetToken yöntemlerinden biri bir erişim belirteci döndürene kadar birden çok |
| ClientAssertionCredential |
JWT onayıyla hizmet sorumlusu kimliğini doğrular. |
| ClientCertificateCredential |
Uygulama Kaydına atanmış PEM kodlu bir sertifika kullanarak Microsoft Entra ID'ye kimlik doğrulamayı etkinleştirir. Sertifika kimlik doğrulamasını yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz: |
| ClientSecretCredential |
Uygulama Kaydı için oluşturulan bir istemci sırrı kullanılarak Microsoft Entra ID'ye kimlik doğrulama imkanı sağlar. İstemci gizli dizisini yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz: |
| 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 istemci kütüphanelerini kullanan çoğu uygulama için çalışan varsayılan bir ChainedTokenCredential yapılandırması sağlar. Daha fazla bilgi için bkz . DefaultAzureCredential'a genel bakış. Aşağıdaki kimlik bilgisi türleri sırayla denenecek:
Kimlik doğrulamayı nasıl denedikleri hakkında daha fazla bilgi için bu kimlik bilgisi türlerinin belgelerine bakın. Aşağıdaki örnekte, örneği oluşturulmadan önce
|
| DeviceCodeCredential |
Kullanıcının https://microsoft.com/devicelogin içine girebileceği bir cihaz kodu kullanarak Microsoft Entra ID kimlik doğrulamasını sağlar. |
| EnvironmentCredential |
İstemci sırrı veya sertifikası kullanarak Microsoft Entra ID'ye kimlik doğrulama imkanı sağlar. |
| InteractiveBrowserCredential |
Etkileşimli giriş akışı kullanılarak web tarayıcısının içinde Microsoft Entra ID'ye kimlik doğrulama sağlanmasını sağlar. |
| 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'lerde, App Service örneklerinde, Azure İşlevleri uygulamalarında, Azure Kubernetes Services'te, Azure Service Fabric örneklerinde ve Azure Cloud Shell'in içinde çalışır. Yönetilen kimlikleri yapılandırma hakkında daha fazla bilgiyi burada bulabilirsiniz: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview |
| OnBehalfOfCredential |
Flow Adına kullanarak Microsoft Entra ID doğrulamasını etkinleştirir. |
| UsernamePasswordCredential |
Kullanıcının kullanıcı adı ve şifresiyle Microsoft Entra ID'ye kimlik doğrulama sağlanmasını sağlar. 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 |
Visual Studio Code'daki Azure Resources uzantısı üzerinden giriş yapmış kullanıcı hesabı 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. |
| WorkloadIdentityCredential |
İş Yükü Kimliği Doğrulaması, Azure'da sanal makinelerde (VM'ler) çalışan uygulamaların hizmet prensibi veya yönetilen kimlik gerektirmeden diğer Azure kaynaklarına erişmesini sağlayan bir özelliktir. İş Yükü Kimliği kimlik doğrulaması ile uygulamalar, paylaşılan hizmet sorumlusu veya yönetilen kimlik kullanmak yerine kendi kimliklerini kullanarak kimliklerini doğrular. Çalışma Yükü Kimliği doğrulaması, Azure tarafından otomatik olarak oluşturulan ve VM'de güvenli bir şekilde saklanan 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'lar otomatik olarak oluşturulup Azure tarafından yönetildiği için, hassas kimlik bilgilerini depolamak ve güvence altına almak konusunda endişelenmenize gerek yok. WorkloadIdentityCredential, Azure Kubernetes'te Microsoft Entra İş Yükü Kimliği doğrulamasını destekler ve Azure Kubernetes ortamında mevcut SAC'ları kullanarak bir token edinir. Daha fazla bilgi için Microsoft Entra İş Yükü Kimliği sayfasına bakabilirsiniz. |
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 |
Microsoft Entra ID'ye kimlik doğrulama talepleri sırasında Identity kütüphanesinin otorite doğrulamasını nasıl yaptığını yapılandırma seçenekleri sunar. |
| AuthorizationCodeCredentialOptions |
AuthorizationCodeCredential seçenekleri |
| AzureCliCredentialOptions |
AzureCliCredential |
| AzureDeveloperCliCredentialOptions |
AzureDeveloperCliCredential seçenekleri |
| AzurePipelinesCredentialOptions |
AzurePipelinesCredential sınıfı için isteğe bağlı parametreler. |
| AzurePowerShellCredentialOptions |
AzurePowerShellCredential |
| 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 |
ClientCertificateCredentialiçin, PEM sertifikasının dize içeriğiyle gerekli yapılandırma seçenekleri |
| ClientCertificatePEMCertificatePath |
ClientCertificateCredentialiç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 |
| 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 |
| DeviceCodeCredentialOptions |
Node.jsiç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 |
Mevcut ortam değişkenlerine bağlı olarak Microsoft Entra ID'ye kimlik doğrulamasını etkinleştirir. EnvironmentCredential sınıfı için seçenekleri tanımlar. |
| ErrorResponse |
Daha fazla ayrıntı için resmi belgelere bakın: https://learn.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1 NOT: Bu belgeler 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şturucuda gönderme seçenekleri.
Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon |
| ManagedIdentityCredentialObjectIdOptions |
ManagedIdentityCredential oluşturucuda gönderme seçenekleri.
Bu çeşitleme, oluşturucu bağımsız değişkeni olarak |
| ManagedIdentityCredentialResourceIdOptions |
ManagedIdentityCredential oluşturucuda gönderme seçenekleri.
Her ikisinde de yalnızca biri desteklendiğinden, bu varyasyon |
| MultiTenantTokenCredentialOptions |
Ek olarak izin verilen kiracılara izin veren çok kiracılı uygulamalar için seçenekler. |
| OnBehalfOfCredentialAssertionOptions |
OnBehalfOfCredential bir onay ile kimliğini doğrulamak için parametreleri tanımlar. |
| OnBehalfOfCredentialCertificateOptions |
OnBehalfOfCredential bir sertifikayla kimliğini doğrulamak için parametreleri tanımlar. |
| OnBehalfOfCredentialSecretOptions |
OnBehalfOfCredential bir gizli diziyle 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 |
Identity kütüphanesinin Microsoft Entra ID'ye kimlik doğrulama taleplerini nasıl yaptığını yapılandırma seçenekleri sunar. |
| UsernamePasswordCredentialOptions |
usernamePasswordCredential sınıfı |
| VisualStudioCodeCredentialOptions |
Visual Studio Code kimlik bilgilerini yapılandırma seçenekleri sunar. |
| WorkloadIdentityCredentialOptions |
WorkloadIdentityCredential seçenekleri |
Tür Diğer Adları
| BrokerOptions |
InteractiveBrowserCredential içinde WAM aracı 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":
|
| ClientCertificateCredentialPEMConfiguration |
ClientCertificateCredentialiçin, PEM sertifikasının dize içeriği veya PEM sertifikasının yolu ile gerekli yapılandırma seçenekleri. |
| DefaultAzureCredentialEnvVars |
DefaultAzureCredential sınıfı için yaygın olarak desteklenen ortam değişkenleri. |
| DeviceCodePromptCallback |
Kullanıcıya kimlik doğrulaması ayrıntılarını görüntülemek amacıyla DeviceCodeCredential'a geçirilecek bir geri çağırmanın imzasını tanımlar. |
| IdentityPlugin |
Azure Identity eklentisinin türü, eklenti bağlamını kabul eden bir fonksiyon. |
| OnBehalfOfCredentialOptions |
OnBehalfOfCredential sınıfı için isteğe bağlı parametreler. |
Numaralandırmalar
| AzureAuthorityHosts |
Bilinen Azure otorite ana bilgisayarlarının listesi |
İşlevler
| deserialize |
Daha önce seri hale getirilmiş bir kimlik doğrulama kaydını bir dizeden nesneye seri durumdan kaldırır. Giriş dizesi aşağıdaki özellikleri içermelidir:
Aldığımız sürüm desteklenmiyorsa bir hata oluşur. Şu anda tek kullanılabilir sürüm şudur: "1.0", kimlik doğrulama kaydı seri hale getirildiğinde her zaman ayarlanır. |
| get |
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:
|
| get |
DefaultAzureCredentialyeni bir örneğini döndürür. |
| serialize |
Bir Serileştirilmiş kimlik doğrulama kaydının çıkışı aşağıdaki özellikleri içerir:
Bu dizeyi daha sonra serileştirilmiş bir |
| use |
Azure Identity'yi ek işlevsellikle genişletin. Eklenti paketinden bir eklenti geçirme, örneğin:
Örnek:
|
Değişkenler
| Aggregate |
AggregateAuthenticationError'un Error.name değeri |
| Authentication |
AuthenticationError'un Error.name değeri |
| Credential |
Credential'ın Error.name değeriErişili Yok |
| logger | Kimlik paketi içindeki tüm istemciler için kullanılan AzureLogger |
İşlev Ayrıntıları
deserializeAuthenticationRecord(string)
Daha önce seri hale getirilmiş bir kimlik doğrulama kaydını bir dizeden nesneye seri durumdan kaldırır.
Giriş dizesi aşağıdaki özellikleri içermelidir:
- "yetki"
- "homeAccountId" (Ev Hesabı Kimliği)
- "clientId" (İstemci Kimliği)
- "kiracı Kimliği"
- "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: "1.0", kimlik doğrulama kaydı seri hale getirildiğinde her zaman ayarlanır.
function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord
Parametreler
- serializedRecord
-
string
Kimlik doğrulama kaydı daha önce dize olarak seri hale getirildi.
Döndürülenler
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, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";
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()
DefaultAzureCredentialyeni bir örneğini döndürür.
function getDefaultAzureCredential(): TokenCredential
Döndürülenler
serializeAuthenticationRecord(AuthenticationRecord)
Bir AuthenticationRecord dize olarak serileştirir.
Serileştirilmiş kimlik doğrulama kaydının çıkışı aşağıdaki özellikleri içerir:
- "yetki"
- "homeAccountId" (Ev Hesabı Kimliği)
- "clientId" (İstemci Kimliği)
- "kiracı Kimliği"
- "kullanıcı adı"
- "sürüm"
Bu dizeyi daha sonra serileştirilmiş bir AuthenticationRecorddönüştürmek için lütfen deserializeAuthenticationRecord()dışarı aktarılan işlevini kullanın.
function serializeAuthenticationRecord(record: AuthenticationRecord): string
Parametreler
- record
- AuthenticationRecord
Döndürülenler
string
useIdentityPlugin(IdentityPlugin)
Azure Identity'yi ek işlevsellikle genişletin. Eklenti paketinden bir eklenti geçirme, örneğin:
-
@azure/identity-cache-persistence: kalıcı belirteç önbelleğe alma sağlar -
@azure/identity-vscode:VisualStudioCodeCredentialbağımlılıklarını sağlar ve etkinleştirir
Örnek:
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
// The plugin has the capability to extend `DeviceCodeCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true,
},
});
function useIdentityPlugin(plugin: IdentityPlugin)
Parametreler
- plugin
- IdentityPlugin
kaydedilecek eklenti
Değişken Ayrıntıları
AggregateAuthenticationErrorName
AggregateAuthenticationError'un Error.name değeri
AggregateAuthenticationErrorName: "AggregateAuthenticationError"
Tür
"AggregateAuthenticationError"
AuthenticationErrorName
AuthenticationError'un Error.name değeri
AuthenticationErrorName: "AuthenticationError"
Tür
"AuthenticationError"
CredentialUnavailableErrorName
Credential'ın Error.name değeriErişili Yok
CredentialUnavailableErrorName: "CredentialUnavailableError"
Tür
"CredentialUnavailableError"
logger
Kimlik paketi içindeki tüm istemciler için kullanılan AzureLogger
logger: AzureLogger