Bagikan melalui

@azure/identity package

  • Referensi

Kelas

AggregateAuthenticationError

Menyediakan array yang berisi instans AuthenticationError untuk kegagalan autentikasi dari kredensial dalamChainedTokenCredential .
AuthenticationError

Menyediakan detail tentang kegagalan untuk mengautentikasi dengan Azure Active Directory. Bidang errorResponse berisi detail selengkapnya tentang kegagalan tertentu.
AuthenticationRequiredError

Kesalahan yang digunakan untuk memberlakukan autentikasi setelah mencoba mengambil token secara diam-diam.
AuthorizationCodeCredential

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan kode otorisasi yang diperoleh melalui alur kode otorisasi, yang dijelaskan secara lebih rinci dalam dokumentasi ID Microsoft Entra:

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 ID Microsoft Entra. 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 ID Microsoft Entra.

Mengonfigurasi AzureDeveloperCliCredential

Untuk menggunakan kredensial ini, pengembang perlu mengautentikasi secara lokal di Azure Developer CLI menggunakan salah satu perintah di bawah ini:

  1. Jalankan "azd auth login" di Azure Developer CLI untuk mengautentikasi secara interaktif sebagai pengguna.
  2. Jalankan "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" untuk mengautentikasi sebagai perwakilan layanan.

Anda mungkin perlu mengulangi proses ini setelah periode waktu tertentu, tergantung pada validitas token refresh di organisasi Anda. Umumnya, periode validitas token refresh adalah beberapa minggu hingga beberapa bulan. AzureDeveloperCliCredential akan meminta Anda untuk masuk lagi.
AzurePipelinesCredential

Kredensial ini dirancang untuk digunakan di Azure Pipelines dengan koneksi layanan sebagai penyiapan untuk federasi identitas beban kerja.
AzurePowerShellCredential

Info masuk 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 Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Memungkinkan beberapa implementasi TokenCredential dicoba secara berurutan sampai salah satu metode getToken mengembalikan token akses.
ClientAssertionCredential

Mengautentikasi perwakilan layanan dengan pernyataan JWT.
ClientCertificateCredential

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan sertifikat yang dikodekan PEM yang ditetapkan ke Pendaftaran Aplikasi. Informasi selengkapnya tentang cara mengonfigurasi autentikasi sertifikat dapat ditemukan di sini:

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

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan rahasia klien yang dihasilkan untuk Pendaftaran Aplikasi. Informasi selengkapnya tentang cara mengonfigurasi rahasia klien dapat ditemukan di sini:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
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 harus berfungsi untuk sebagian besar aplikasi yang menggunakan Azure SDK.
DeviceCodeCredential

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan kode perangkat yang dapat dimasukkan pengguna ke https://microsoft.com/devicelogin.
EnvironmentCredential

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan rahasia atau sertifikat klien, atau sebagai pengguna dengan nama pengguna dan kata sandi.
InteractiveBrowserCredential

Mengaktifkan autentikasi ke ID Microsoft Entra 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 Azure Cloud Shell.

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

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan Atas Nama alur.
UsernamePasswordCredential

Mengaktifkan autentikasi ke ID Microsoft Entra 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 diketahui bahwa kredensial ini tidak berfungsi dengan ekstensi Akun Azure versi 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 SAK dibuat secara otomatis dan dikelola oleh Azure, Anda tidak perlu khawatir tentang menyimpan dan mengamankan kredensial sensitif itu sendiri. WorkloadIdentityCredential mendukung autentikasi ID Beban Kerja Microsoft Entra di Azure Kubernetes dan memperoleh token menggunakan SAC yang tersedia di lingkungan Azure Kubernetes. Lihat ID Beban Kerja Microsoft Entra 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 ke ID Microsoft Entra.
AuthorizationCodeCredentialOptions

Opsi untuk AuthorizationCodeCredential
AzureCliCredentialOptions

Opsi untuk AzureCliCredential

AzureDeveloperCliCredentialOptions

Opsi untuk AzureDeveloperCliCredential
AzurePipelinesCredentialOptions

Parameter opsional untuk kelas AzurePipelinesCredential.
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 untukClientCertificateCredential , dengan konten string sertifikat PEM
ClientCertificatePEMCertificatePath

Opsi konfigurasi yang diperlukan untukClientCertificateCredential , 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 managedIdentityClientId dan tidak managedIdentityResourceId, karena hanya salah satu dari keduanya yang didukung.
DefaultAzureCredentialOptions

Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential.
DefaultAzureCredentialResourceIdOptions

Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential. Variasi ini mendukung managedIdentityResourceId dan tidak managedIdentityClientId, karena hanya salah satu dari keduanya yang didukung.
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

Mengaktifkan autentikasi ke ID Microsoft Entra tergantung pada variabel lingkungan yang tersedia. Menentukan opsi untuk kelas EnvironmentCredential.
ErrorResponse

Lihat dokumentasi resmi untuk detail selengkapnya:

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

CATATAN: Dokumentasi ini untuk dukungan OAuth v1 tetapi detail respons kesalahan yang sama masih berlaku untuk v2.
GetBearerTokenProviderOptions

Opsi untuk mengonfigurasi penyedia token.
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 konstruktor ManagedIdentityCredential. Variasi ini mendukung clientId dan tidak resourceId, karena hanya salah satu dari keduanya yang didukung.
ManagedIdentityCredentialResourceIdOptions

Opsi untuk mengirim konstruktor ManagedIdentityCredential. Variasi ini mendukung resourceId dan tidak clientId, karena hanya salah satu dari keduanya yang didukung.
MultiTenantTokenCredentialOptions

Opsi untuk aplikasi multi-penyewa yang memungkinkan penyewa yang diizinkan tambahan.
OnBehalfOfCredentialAssertionOptions

Menentukan parameter untuk mengautentikasi OnBehalfOfCredential dengan pernyataan.
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 ke ID Microsoft Entra.
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:

  • "alihkan" mengalihkan pengguna ke halaman autentikasi lalu mengalihkannya kembali ke halaman setelah autentikasi selesai.
  • "popup" membuka jendela browser baru dengan alur pengalihan dimulai. Jendela browser pengguna yang sudah ada tidak meninggalkan halaman saat ini
ClientCertificateCredentialPEMConfiguration

Opsi konfigurasi yang diperlukan untukClientCertificateCredential , 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

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 ketika rekaman autentikasi diserialisasikan.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Mengembalikan panggilan balik yang menyediakan token pembawa. Misalnya, token pembawa dapat digunakan untuk mengautentikasi permintaan sebagai berikut:

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()

Mengembalikan instans baru DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Menserialisasikan AuthenticationRecord ke dalam string.

Output rekaman autentikasi berseri akan berisi properti berikut:

  • "otoritas"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nama pengguna"
  • "versi"

Untuk mengonversi string ini ke AuthenticationRecordyang diserialisasikan, gunakan fungsi yang diekspor deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Perluas Azure Identity dengan fungsionalitas tambahan. Berikan plugin dari paket plugin, seperti:

  • @azure/identity-cache-persistence: menyediakan penembolokan token persisten
  • @azure/identity-vscode: menyediakan dependensi VisualStudioCodeCredential 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
  }
});

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 ketika rekaman autentikasi diserialisasikan.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parameter

serializedRecord

string

Rekaman autentikasi sebelumnya diserialisasikan ke dalam string.

Mengembalikan

AuthenticationRecord

AuthenticationRecord.

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

Mengembalikan panggilan balik yang menyediakan token pembawa. Misalnya, token pembawa dapat digunakan untuk mengautentikasi permintaan sebagai berikut:

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>

Parameter

credential
TokenCredential

Kredensial yang digunakan untuk mengautentikasi permintaan.

scopes

string | string[]

Cakupan yang diperlukan untuk token pembawa.

options
GetBearerTokenProviderOptions

Opsi untuk mengonfigurasi penyedia token.

Mengembalikan

() => Promise<string>

panggilan balik yang menyediakan token pembawa.

getDefaultAzureCredential()

Mengembalikan instans baru DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Mengembalikan

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Menserialisasikan AuthenticationRecord ke dalam string.

Output rekaman autentikasi berseri akan berisi properti berikut:

  • "otoritas"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nama pengguna"
  • "versi"

Untuk mengonversi string ini ke AuthenticationRecordyang diserialisasikan, gunakan fungsi yang diekspor deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parameter

record
AuthenticationRecord

Mengembalikan

string

useIdentityPlugin(IdentityPlugin)

Perluas Azure Identity dengan fungsionalitas tambahan. Berikan plugin dari paket plugin, seperti:

  • @azure/identity-cache-persistence: menyediakan penembolokan token persisten
  • @azure/identity-vscode: menyediakan dependensi VisualStudioCodeCredential 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