DefaultAzureCredential class
Menyediakan konfigurasi ChainedTokenCredential default yang berfungsi untuk sebagian besar aplikasi yang menggunakan pustaka klien Azure SDK. Untuk informasi selengkapnya, lihat Gambaran umum DefaultAzureCredential.
Jenis kredensial berikut akan dicoba, secara berurutan:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (kredensial yang diaktifkan broker yang memerlukan @azure/identity-broker diinstal)
Lihat dokumentasi jenis kredensial ini untuk informasi selengkapnya tentang cara mereka mencoba autentikasi.
Contoh berikut menunjukkan cara menggunakan requiredEnvVars opsi untuk memastikan bahwa variabel lingkungan tertentu diatur sebelum dibuat DefaultAzureCredential .
Jika salah satu variabel lingkungan yang ditentukan hilang atau kosong, kesalahan akan muncul, mencegah aplikasi melanjutkan eksekusi tanpa konfigurasi yang diperlukan.
Ini juga menunjukkan cara mengatur AZURE_TOKEN_CREDENTIALS variabel lingkungan untuk mengontrol kredensial mana yang disertakan dalam rantai.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Memperluas
Konstruktor
| Default |
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialClientIdOptions. |
| Default |
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialOptions. |
| Default |
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialResourceIdOptions. |
Metode yang Diwarisi
| get |
Mengembalikan token akses pertama yang dikembalikan oleh salah satu implementasi Metode ini dipanggil secara otomatis oleh pustaka klien Azure SDK. Anda dapat memanggil metode ini secara langsung, tetapi Anda juga harus menangani penembolokan token dan refresh token. |
Detail Konstruktor
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Parameter
Parameter opsional. Lihat DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Parameter
- options
- DefaultAzureCredentialOptions
Parameter opsional. Lihat DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Membuat instans kelas DefaultAzureCredential dengan DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Parameter
Parameter opsional. Lihat DefaultAzureCredentialResourceIdOptions.
Detail Metode yang Diwarisi
getToken(string | string[], GetTokenOptions)
Mengembalikan token akses pertama yang dikembalikan oleh salah satu implementasi TokenCredential berantai. Melempar AggregateAuthenticationError ketika satu atau beberapa kredensial melempar AuthenticationError dan tidak ada kredensial yang mengembalikan token akses.
Metode ini dipanggil secara otomatis oleh pustaka klien Azure SDK. Anda dapat memanggil metode ini secara langsung, tetapi Anda juga harus menangani penembolokan token dan refresh token.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Parameter
- scopes
-
string | string[]
Daftar cakupan yang tokennya akan memiliki akses.
- options
- GetTokenOptions
Opsi yang digunakan untuk mengonfigurasi permintaan apa pun yang mungkin dibuat implementasi TokenCredential ini.
Mengembalikan
Promise<AccessToken>
Diwariskan DariChainedTokenCredential.getToken