DefaultAzureCredential class
Azure SDK istemci kitaplıklarını kullanan çoğu uygulama için çalışan bir varsayılan 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:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (yüklü olmasını gerektiren @azure/identity-broker aracı özellikli bir kimlik bilgisi)
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 requiredEnvVars belirli ortam değişkenlerinin ayarlandığından emin olmak için seçeneğin DefaultAzureCredential nasıl kullanılacağı gösterilmektedir.
Belirtilen ortam değişkenlerinden herhangi biri eksik veya boşsa, uygulamanın gerekli yapılandırma olmadan yürütmeye devam etmesini engelleyen bir hata atılır.
Ayrıca, zincire AZURE_TOKEN_CREDENTIALS hangi kimlik bilgilerinin dahil edildiğini denetlemek için ortam değişkeninin nasıl ayarlanacağını da gösterir.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Extends
Oluşturucular
| Default |
DefaultAzureCredentialClientIdOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur. |
| Default |
DefaultAzureCredentialOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur. |
| Default |
DefaultAzureCredentialResourceIdOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur. |
Devralınan Yöntemler
| get |
Zincirlenmiş Bu yöntem, Azure SDK istemci kitaplıkları tarafından otomatik olarak çağrılır. Bu yöntemi doğrudan çağırabilirsiniz, ancak belirteç önbelleğe alma ve belirteç yenileme işlemlerini de işlemeniz gerekir. |
Oluşturucu Ayrıntıları
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
DefaultAzureCredentialClientIdOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Parametreler
İsteğe bağlı parametreler. Bkz. DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
DefaultAzureCredentialOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Parametreler
- options
- DefaultAzureCredentialOptions
İsteğe bağlı parametreler. Bkz. DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
DefaultAzureCredentialResourceIdOptions ile DefaultAzureCredential sınıfının bir örneğini oluşturur.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Parametreler
İsteğe bağlı parametreler. Bkz. DefaultAzureCredentialResourceIdOptions.
Devralınan Yöntemin Ayrıntıları
getToken(string | string[], GetTokenOptions)
Zincirlenmiş TokenCredential uygulamalarından biri tarafından döndürülen ilk erişim belirtecini döndürür. Bir veya daha fazla kimlik bilgisi AuthenticationError oluşturup hiçbir kimlik bilgisi erişim belirteci döndürmediğinde bir AggregateAuthenticationError oluşturur.
Bu yöntem, Azure SDK istemci kitaplıkları tarafından otomatik olarak çağrılır. Bu yöntemi doğrudan çağırabilirsiniz, ancak belirteç önbelleğe alma ve belirteç yenileme işlemlerini de işlemeniz gerekir.
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>
Devralındığı yer:ChainedTokenCredential.getToken