@azure/identity package
Kelas
AggregateAuthenticationError |
Menyediakan array yang |
AuthenticationError |
Menyediakan detail tentang kegagalan untuk mengautentikasi dengan Azure Active Directory. Bidang |
AuthenticationRequiredError |
Kesalahan yang digunakan untuk memberlakukan autentikasi setelah mencoba mengambil token secara diam-diam. |
AuthorizationCodeCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan kode otorisasi yang diperoleh melalui alur kode otorisasi, yang dijelaskan secara lebih rinci dalam dokumentasi Microsoft Entra ID: https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow |
AzureCliCredential |
Kredensial ini akan menggunakan informasi masuk pengguna yang saat ini masuk melalui alat commandline Azure CLI ('az'). Untuk melakukannya, ini akan membaca token akses pengguna dan waktu kedaluwarsa dengan perintah Azure CLI "az account get-access-token". |
AzureDeveloperCliCredential |
Azure Developer CLI adalah alat antarmuka baris perintah yang memungkinkan pengembang membuat, mengelola, dan menyebarkan sumber daya di Azure. Ini dibangun di atas Azure CLI dan menyediakan fungsionalitas tambahan khusus untuk pengembang Azure. Ini memungkinkan pengguna untuk mengautentikasi sebagai pengguna dan/atau perwakilan layanan terhadap Microsoft Entra ID. AzureDeveloperCliCredential mengautentikasi di lingkungan pengembangan dan memperoleh token atas nama pengguna atau perwakilan layanan yang masuk di Azure Developer CLI. Ini bertindak sebagai Azure Developer CLI yang masuk ke pengguna atau perwakilan layanan dan menjalankan perintah Azure CLI di bawahnya untuk mengautentikasi aplikasi terhadap Microsoft Entra ID. Mengonfigurasi AzureDeveloperCliCredentialUntuk menggunakan kredensial ini, pengembang perlu mengautentikasi secara lokal dalam Azure Developer CLI menggunakan salah satu perintah di bawah ini:
Anda mungkin perlu mengulangi proses ini setelah jangka waktu tertentu, tergantung pada validitas token refresh di organisasi Anda. Umumnya, masa berlaku token refresh adalah beberapa minggu hingga beberapa bulan. AzureDeveloperCliCredential akan meminta Anda untuk masuk lagi. |
AzurePowerShellCredential |
Kredensial ini akan menggunakan informasi pengguna yang saat ini masuk dari modul Azure PowerShell. Untuk melakukannya, ini akan membaca token akses pengguna dan waktu kedaluwarsa dengan perintah Azure PowerShell |
ChainedTokenCredential |
Memungkinkan beberapa |
ClientAssertionCredential |
Mengautentikasi perwakilan layanan dengan pernyataan JWT. |
ClientCertificateCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan sertifikat yang dikodekan PEM yang ditetapkan ke Pendaftaran Aplikasi. Informasi selengkapnya tentang cara mengonfigurasi autentikasi sertifikat dapat ditemukan di sini: |
ClientSecretCredential |
Memungkinkan autentikasi Microsoft Entra ID menggunakan rahasia klien yang dihasilkan untuk Pendaftaran Aplikasi. Informasi selengkapnya tentang cara mengonfigurasi rahasia klien dapat ditemukan di sini: |
CredentialUnavailableError |
Ini menandakan bahwa kredensial yang dicoba dalam kredensial berantai tidak tersedia untuk digunakan sebagai kredensial. Daripada memperlakukan ini sebagai kesalahan yang harus menghentikan rantai, rantai tertangkap dan rantai berlanjut |
DefaultAzureCredential |
Menyediakan konfigurasi ChainedTokenCredential default yang seharusnya berfungsi untuk sebagian besar aplikasi yang menggunakan Azure SDK. |
DeviceCodeCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan kode perangkat yang dapat dimasukkan pengguna ke dalam https://microsoft.com/devicelogin. |
EnvironmentCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan rahasia atau sertifikat klien, atau sebagai pengguna dengan nama pengguna dan kata sandi. |
InteractiveBrowserCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID di dalam browser web menggunakan alur masuk interaktif. |
ManagedIdentityCredential |
Mencoba autentikasi menggunakan identitas terkelola yang tersedia di lingkungan penyebaran. Jenis autentikasi ini berfungsi di Azure VM, instans App Service, aplikasi Azure Functions, Azure Kubernetes Services, instans Azure Service Fabric, dan di dalam Cloud Shell Azure. Informasi selengkapnya tentang mengonfigurasi identitas terkelola dapat ditemukan di sini: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview |
OnBehalfOfCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan alur Atas Nama. |
UsernamePasswordCredential |
Memungkinkan autentikasi untuk Microsoft Entra ID dengan nama pengguna dan kata sandi pengguna. Kredensial ini memerlukan tingkat kepercayaan yang tinggi sehingga Anda hanya boleh menggunakannya ketika jenis kredensial lain yang lebih aman tidak dapat digunakan. |
VisualStudioCodeCredential |
Menyambungkan ke Azure menggunakan kredensial yang disediakan oleh ekstensi VSCode 'Akun Azure'. Setelah pengguna masuk melalui ekstensi, kredensial ini dapat berbagi token refresh yang sama yang di-cache oleh ekstensi. Ini adalah masalah yang diketahui bahwa kredensial ini tidak berfungsi dengan versi ekstensi Akun Azure yang lebih baru dari 0.9.11. Perbaikan jangka panjang untuk masalah ini sedang berlangsung. Sementara itu, pertimbangkan untuk mengautentikasi dengan AzureCliCredential. |
WorkloadIdentityCredential |
Autentikasi Identitas Beban Kerja adalah fitur di Azure yang memungkinkan aplikasi yang berjalan pada komputer virtual (VM) untuk mengakses sumber daya Azure lainnya tanpa memerlukan perwakilan layanan atau identitas terkelola. Dengan autentikasi Identitas Beban Kerja, aplikasi mengautentikasi diri mereka sendiri menggunakan identitas mereka sendiri, daripada menggunakan perwakilan layanan bersama atau identitas terkelola. Di bawah tenda, autentikasi Identitas Beban Kerja menggunakan konsep Kredensial Akun Layanan (SAC), yang secara otomatis dibuat oleh Azure dan disimpan dengan aman di VM. Dengan menggunakan autentikasi Identitas Beban Kerja, Anda dapat menghindari kebutuhan untuk mengelola dan memutar perwakilan layanan atau identitas terkelola untuk setiap aplikasi pada setiap VM. Selain itu, karena SAC dibuat secara otomatis dan dikelola oleh Azure, Anda tidak perlu khawatir tentang menyimpan dan mengamankan kredensial sensitif itu sendiri. WorkloadIdentityCredential mendukung autentikasi Microsoft Entra Workload ID pada Azure Kubernetes dan memperoleh token menggunakan SAC yang tersedia di lingkungan Azure Kubernetes. Lihat Microsoft Entra Workload ID untuk informasi selengkapnya. |
Antarmuka
AccessToken |
Mewakili token akses dengan waktu kedaluwarsa. |
AuthenticationRecord |
Catatan yang digunakan untuk menemukan token yang di-cache di cache. |
AuthenticationRequiredErrorOptions |
Parameter opsional ke AuthenticationRequiredError |
AuthorityValidationOptions |
Menyediakan opsi untuk mengonfigurasi bagaimana pustaka Identitas melakukan validasi otoritas selama permintaan autentikasi untuk Microsoft Entra ID. |
AuthorizationCodeCredentialOptions |
Opsi untuk AuthorizationCodeCredential |
AzureCliCredentialOptions |
Opsi untuk AzureCliCredential |
AzureDeveloperCliCredentialOptions |
Opsi untuk AzureDeveloperCliCredential |
AzurePowerShellCredentialOptions |
Opsi untuk AzurePowerShellCredential |
BrokerAuthOptions |
Opsi konfigurasi untuk InteractiveBrowserCredential untuk mendukung Autentikasi Broker WAM. |
BrokerDisabledOptions |
Parameter saat autentikasi broker WAM dinonaktifkan. |
BrokerEnabledOptions |
Parameter saat autentikasi broker WAM diaktifkan. |
BrowserCustomizationOptions |
Opsi konfigurasi bersama untuk kustomisasi browser |
ClientAssertionCredentialOptions |
Opsi untuk ClientAssertionCredential |
ClientCertificateCredentialOptions |
Parameter opsional untuk kelas ClientCertificateCredential . |
ClientCertificatePEMCertificate |
Opsi konfigurasi yang diperlukan untuk ClientCertificateCredential, dengan konten string sertifikat PEM |
ClientCertificatePEMCertificatePath |
Opsi konfigurasi yang diperlukan untuk ClientCertificateCredential, dengan jalur ke sertifikat PEM. |
ClientSecretCredentialOptions |
Parameter opsional untuk kelas ClientSecretCredential . |
CredentialPersistenceOptions |
Opsi konfigurasi bersama untuk kredensial yang mendukung penembolokan token persisten. |
DefaultAzureCredentialClientIdOptions |
Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential .
Variasi ini mendukung |
DefaultAzureCredentialOptions |
Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential . |
DefaultAzureCredentialResourceIdOptions |
Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential .
Variasi ini mendukung |
DeviceCodeCredentialOptions |
Menentukan opsi untuk kelas InteractiveBrowserCredential untuk Node.js. |
DeviceCodeInfo |
Menyediakan kode pengguna dan URI verifikasi tempat kode harus dimasukkan. Juga menyediakan pesan untuk ditampilkan kepada pengguna yang berisi instruksi dengan detail ini. |
EnvironmentCredentialOptions |
Memungkinkan autentikasi untuk Microsoft Entra ID tergantung pada variabel lingkungan yang tersedia. Menentukan opsi untuk kelas EnvironmentCredential. |
ErrorResponse |
Lihat dokumentasi resmi untuk detail selengkapnya: CATATAN: Dokumentasi ini untuk dukungan OAuth v1 tetapi detail respons kesalahan yang sama masih berlaku untuk v2. |
GetTokenOptions |
Menentukan opsi untuk TokenCredential.getToken. |
InteractiveBrowserCredentialInBrowserOptions |
Menentukan opsi umum untuk kelas InteractiveBrowserCredential. |
InteractiveBrowserCredentialNodeOptions |
Menentukan opsi umum untuk kelas InteractiveBrowserCredential. |
InteractiveCredentialOptions |
Opsi konstruktor umum untuk kredensial Identitas yang memerlukan interaksi pengguna. |
ManagedIdentityCredentialClientIdOptions |
Opsi untuk mengirim pada konstruktor ManagedIdentityCredential .
Variasi ini mendukung |
ManagedIdentityCredentialResourceIdOptions |
Opsi untuk mengirim pada konstruktor ManagedIdentityCredential .
Variasi ini mendukung |
MultiTenantTokenCredentialOptions |
Opsi untuk aplikasi multi-penyewa yang memungkinkan penyewa yang diizinkan tambahan. |
OnBehalfOfCredentialCertificateOptions |
Menentukan parameter untuk mengautentikasi OnBehalfOfCredential dengan sertifikat. |
OnBehalfOfCredentialSecretOptions |
Menentukan parameter untuk mengautentikasi OnBehalfOfCredential dengan rahasia. |
TokenCachePersistenceOptions |
Parameter yang memungkinkan persistensi cache token dalam kredensial Identitas. |
TokenCredential |
Mewakili kredensial yang mampu menyediakan token autentikasi. |
TokenCredentialOptions |
Menyediakan opsi untuk mengonfigurasi bagaimana pustaka Identitas membuat permintaan autentikasi untuk Microsoft Entra ID. |
UsernamePasswordCredentialOptions |
Menentukan opsi untuk kelas UsernamePasswordCredential . |
VisualStudioCodeCredentialOptions |
Menyediakan opsi untuk mengonfigurasi kredensial Visual Studio Code. |
WorkloadIdentityCredentialOptions |
Opsi untuk WorkloadIdentityCredential |
Alias Jenis
BrokerOptions |
Parameter yang memungkinkan autentikasi broker WAM di InteractiveBrowserCredential. |
BrowserLoginStyle |
(Fitur khusus browser) "Gaya masuk" untuk digunakan dalam alur autentikasi:
|
ClientCertificateCredentialPEMConfiguration |
Opsi konfigurasi yang diperlukan untuk ClientCertificateCredential, dengan konten string sertifikat PEM, atau jalur ke sertifikat PEM. |
DeviceCodePromptCallback |
Menentukan tanda tangan panggilan balik yang akan diteruskan ke DeviceCodeCredential untuk tujuan menampilkan detail autentikasi kepada pengguna. |
IdentityPlugin |
Jenis plugin Azure Identity, fungsi yang menerima konteks plugin. |
OnBehalfOfCredentialOptions |
Parameter opsional untuk kelas OnBehalfOfCredential . |
Enum
AzureAuthorityHosts |
Daftar host otoritas Azure yang diketahui |
Fungsi
deserialize |
Mendeserialisasi rekaman autentikasi yang diserialisasikan sebelumnya dari string ke dalam objek. String input harus berisi properti berikut:
Jika versi yang kami terima tidak didukung, kesalahan akan dilemparkan. Saat ini, satu-satunya versi yang tersedia adalah: "1.0", yang selalu diatur saat rekaman autentikasi diserialisasikan. |
get |
Mengembalikan instans baru DefaultAzureCredential. |
serialize |
Menserialisasikan Output rekaman autentikasi berseri akan berisi properti berikut:
Untuk nanti mengonversi string ini menjadi serial |
use |
Perluas Azure Identity dengan fungsionalitas tambahan. Teruskan plugin dari paket plugin, seperti:
Contoh:
|
Detail Fungsi
deserializeAuthenticationRecord(string)
Mendeserialisasi rekaman autentikasi yang diserialisasikan sebelumnya dari string ke dalam objek.
String input harus berisi properti berikut:
- "otoritas"
- "homeAccountId"
- "clientId"
- "tenantId"
- "nama pengguna"
- "versi"
Jika versi yang kami terima tidak didukung, kesalahan akan dilemparkan.
Saat ini, satu-satunya versi yang tersedia adalah: "1.0", yang selalu diatur saat rekaman autentikasi diserialisasikan.
function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord
Parameter
- serializedRecord
-
string
Rekaman autentikasi sebelumnya diserialisasikan ke dalam string.
Mengembalikan
AuthenticationRecord.
getDefaultAzureCredential()
Mengembalikan instans baru DefaultAzureCredential.
function getDefaultAzureCredential(): TokenCredential
Mengembalikan
serializeAuthenticationRecord(AuthenticationRecord)
Menserialisasikan AuthenticationRecord
ke dalam string.
Output rekaman autentikasi berseri akan berisi properti berikut:
- "otoritas"
- "homeAccountId"
- "clientId"
- "tenantId"
- "nama pengguna"
- "versi"
Untuk nanti mengonversi string ini menjadi serial AuthenticationRecord
, gunakan fungsi deserializeAuthenticationRecord()
yang diekspor .
function serializeAuthenticationRecord(record: AuthenticationRecord): string
Parameter
- record
- AuthenticationRecord
Mengembalikan
string
useIdentityPlugin(IdentityPlugin)
Perluas Azure Identity dengan fungsionalitas tambahan. Teruskan plugin dari paket plugin, seperti:
@azure/identity-cache-persistence
: menyediakan penembolokan token persisten@azure/identity-vscode
: menyediakan dependensiVisualStudioCodeCredential
dan mengaktifkannya
Contoh:
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)
Parameter
- plugin
- IdentityPlugin
plugin untuk mendaftar