ConfidentialClientApplicationBuilder Kelas

Definisi

public class ConfidentialClientApplicationBuilder : Microsoft.Identity.Client.AbstractApplicationBuilder<Microsoft.Identity.Client.ConfidentialClientApplicationBuilder>
type ConfidentialClientApplicationBuilder = class
    inherit AbstractApplicationBuilder<ConfidentialClientApplicationBuilder>
Public Class ConfidentialClientApplicationBuilder
Inherits AbstractApplicationBuilder(Of ConfidentialClientApplicationBuilder)
Warisan

Metode

Nama Deskripsi
Build()

Membangun instans dari IConfidentialClientApplication parameter yang diatur dalam ConfidentialClientApplicationBuilder.

Create(String)

Membuat ConfidentialClientApplicationBuilder dari clientID. Lihat https://aka.ms/msal-net-application-configuration

CreateWithApplicationOptions(ConfidentialClientApplicationOptions)

Konstruktor ConfidentialClientApplicationBuilder dari opsi konfigurasi aplikasi. Lihat https://aka.ms/msal-net-application-configuration

WithAdfsAuthority(String, Boolean)

Menambahkan Otoritas yang diketahui sesuai dengan server ADFS. Lihat https://aka.ms/msal-net-adfs

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(AadAuthorityAudience, Boolean)

Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna yang menentukan audiens masuk (cloud menjadi cloud publik Azure). Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)

Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna yang menentukan instans cloud dan audiens masuk. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, Guid, Boolean)

Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh instans cloud dan ID penyewanya. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, String, Boolean)

Menambahkan otoritas AD Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh instans cloud dan nama domain atau ID penyewanya. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(String, Boolean)

Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna yang menentukan URI otoritas penuh. Lihat Opsi konfigurasi aplikasi.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(String, Guid, Boolean)

Menambahkan otoritas AD Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang ditentukan oleh ID penyewanya. Lihat Opsi konfigurasi aplikasi.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(String, String, Boolean)

Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh nama domainnya. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAuthority(Uri, Boolean)

Menambahkan otoritas yang diketahui ke aplikasi. Lihat Opsi konfigurasi aplikasi. Konstruktor ini terutama digunakan untuk skenario di mana otoritas bukan otoritas Azure AD standar, atau otoritas ADFS, atau otoritas AD B2C Azure. Untuk Azure AD, bahkan di sovereign cloud, lebih suka menggunakan penimpaan lain sepertiWithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)

(Diperoleh dari AbstractApplicationBuilder<T>)
WithAzureRegion(String)

Menginstruksikan MSAL untuk menggunakan layanan token regional Azure. Fitur ini saat ini hanya tersedia untuk aplikasi pihak pertama.

WithB2CAuthority(String)

Menambahkan otoritas yang diketahui sesuai dengan kebijakan AD B2C Azure. Lihat https://aka.ms/msal-net-b2c-specificities

(Diperoleh dari AbstractApplicationBuilder<T>)
WithCacheOptions(CacheOptions)

Opsi untuk cache token MSAL.

MSAL mempertahankan cache token secara internal dalam memori. Secara default, objek cache ini adalah bagian dari setiap instans PublicClientApplication atau ConfidentialClientApplication. Metode ini memungkinkan penyesuaian cache token dalam memori MSAL.

Cache memori MSAL berbeda dari serialisasi cache token. Serialisasi cache menarik token dari cache (misalnya Redis, Cosmos, atau file pada disk), di mana mereka disimpan dalam format JSON, ke dalam cache memori internal MSAL. Operasi cache memori tidak melibatkan operasi JSON.

Serialisasi cache eksternal tetap menjadi cara yang disarankan untuk menangani aplikasi desktop, situs web, dan API web, karena memberikan persistensi. Opsi ini saat ini tidak mengontrol serialisasi cache eksternal.

Panduan terperinci untuk setiap jenis dan platform aplikasi: https://aka.ms/msal-net-token-cache-serialization

(Diperoleh dari AbstractApplicationBuilder<T>)
WithCacheSynchronization(Boolean)

Ketika diatur ke true, MSAL akan mengunci akses cache pada ConfidentialClientApplication tingkat, yaitu blok kode antara callback BeforeAccessAsync dan AfterAccessAsync akan disinkronkan. Aplikasi dapat mengatur bendera ini untuk false mengaktifkan strategi penguncian cache optimis, yang dapat menghasilkan performa yang lebih baik dengan biaya konsistensi cache. Mengatur bendera ini hanya false disarankan untuk aplikasi yang membuat baru ConfidentialClientApplication per permintaan.

WithCertificate(X509Certificate2, Boolean)

Mengatur sertifikat yang terkait dengan aplikasi. Hanya berlaku untuk aplikasi pihak pertama, metode ini juga memungkinkan untuk menentukan apakah klaim x5c harus dikirim ke Azure AD. Mengirim x5c memungkinkan pengembang aplikasi untuk mencapai roll-over sertifikat yang mudah di Azure AD: metode ini akan mengirim rantai sertifikat ke Azure AD bersama dengan permintaan token, sehingga Azure AD dapat menggunakannya untuk memvalidasi nama subjek berdasarkan kebijakan penerbit tepercaya. Ini menyimpan admin aplikasi dari kebutuhan untuk mengelola rollover sertifikat secara eksplisit (baik melalui portal atau operasi PowerShell/CLI). Untuk detailnya lihat https://aka.ms/msal-net-sni

WithCertificate(X509Certificate2, CertificateOptions)

Mengatur sertifikat yang terkait dengan aplikasi. Hanya berlaku untuk aplikasi pihak pertama, metode ini juga memungkinkan untuk menentukan apakah klaim x5c harus dikirim ke Azure AD. Mengirim x5c memungkinkan pengembang aplikasi untuk mencapai roll-over sertifikat yang mudah di Azure AD: metode ini akan mengirim rantai sertifikat ke Azure AD bersama dengan permintaan token, sehingga Azure AD dapat menggunakannya untuk memvalidasi nama subjek berdasarkan kebijakan penerbit tepercaya. Ini menyimpan admin aplikasi dari kebutuhan untuk mengelola rollover sertifikat secara eksplisit (baik melalui portal atau operasi PowerShell/CLI). Untuk detailnya lihat https://aka.ms/msal-net-sni

WithCertificate(X509Certificate2)

Mengatur sertifikat yang terkait dengan aplikasi.

WithClientAssertion(Func<AssertionRequestOptions,CancellationToken,Task<ClientSignedAssertion>>)

Mengonfigurasi aplikasi klien untuk menggunakan pernyataan klien untuk autentikasi.

WithClientAssertion(Func<AssertionRequestOptions,Task<String>>)

Mengonfigurasi delegasi asinkron yang membuat pernyataan klien. Delegasi dipanggil hanya ketika token tidak dapat diambil dari cache. Lihat https://aka.ms/msal-net-client-assertion

WithClientAssertion(Func<CancellationToken,Task<String>>)

Mengonfigurasi delegasi asinkron yang membuat pernyataan klien. Lihat https://aka.ms/msal-net-client-assertion

WithClientAssertion(Func<String>)

Mengonfigurasi delegasi yang membuat pernyataan klien. Lihat https://aka.ms/msal-net-client-assertion

WithClientAssertion(String)
Kedaluwarsa.

Mengatur pernyataan klien aplikasi. Lihat https://aka.ms/msal-net-client-assertion. Ini akan membuat pernyataan yang akan disimpan dalam memori aplikasi klien selama durasi klien. Anda dapat menggunakan WithClientAssertion(Func<String>) untuk mengatur delegasi yang akan dijalankan untuk setiap permintaan autentikasi. Ini akan memungkinkan Anda memperbarui pernyataan klien yang digunakan oleh aplikasi klien setelah pernyataan kedaluwarsa.

WithClientCapabilities(IEnumerable<String>)

Microsoft Ekstensi OIDC khusus identitas yang memungkinkan tantangan sumber daya diselesaikan tanpa interaksi. Memungkinkan konfigurasi satu atau beberapa kemampuan klien, misalnya "llt"

(Diperoleh dari AbstractApplicationBuilder<T>)
WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean, Boolean)
Kedaluwarsa.

Mengatur sertifikat yang terkait dengan aplikasi bersama dengan klaim tertentu untuk ditandatangani. Secara default, ini akan menggabungkan claimsToSign dengan kumpulan klaim default yang diperlukan untuk autentikasi. Jika mergeWithDefaultClaims diatur ke false, Anda harus memberikan klaim default yang diperlukan. Lihat https://aka.ms/msal-net-client-assertion

WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean)
Kedaluwarsa.

Mengatur sertifikat yang terkait dengan aplikasi bersama dengan klaim tertentu untuk ditandatangani. Secara default, ini akan menggabungkan claimsToSign dengan kumpulan klaim default yang diperlukan untuk autentikasi. Jika mergeWithDefaultClaims diatur ke false, Anda harus memberikan klaim default yang diperlukan. Lihat https://aka.ms/msal-net-client-assertion

WithClientId(String)

Mengatur ID Klien aplikasi

(Diperoleh dari AbstractApplicationBuilder<T>)
WithClientName(String)

Mengatur nama API SDK panggilan untuk tujuan telemetri.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithClientSecret(String)

Mengatur rahasia aplikasi

WithClientVersion(String)

Mengatur versi SDK panggilan untuk tujuan telemetri.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithDebugLoggingCallback(LogLevel, Boolean, Boolean)

Mengatur panggilan balik pengelogan Debug ke metode debug default yang menampilkan tingkat pesan dan pesan itu sendiri. Untuk detailnya lihat https://aka.ms/msal-net-logging

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithExperimentalFeatures(Boolean)

Memungkinkan penggunaan fitur eksperimental dan API. Jika bendera ini tidak diatur, fitur eksperimental akan melemparkan pengecualian. Untuk detailnya lihat https://aka.ms/msal-net-experimental-features

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithExtraQueryParameters(IDictionary<String,String>)
Kedaluwarsa.

Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP

(Diperoleh dari AbstractApplicationBuilder<T>)
WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>)

Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP dengan kontrol atas parameter mana yang disertakan dalam kunci cache

(Diperoleh dari AbstractApplicationBuilder<T>)
WithExtraQueryParameters(String)
Kedaluwarsa.

Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP

(Diperoleh dari AbstractApplicationBuilder<T>)
WithGenericAuthority(String)
Kedaluwarsa.

Hubungi WithOidcAuthority(String) sebagai gantinya.

WithHttpClientFactory(IMsalHttpClientFactory, Boolean)

Menggunakan khusus IMsalHttpClientFactory untuk berkomunikasi dengan IdP. Ini memungkinkan skenario tingkat lanjut seperti mengatur proksi, atau mengatur Agen.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithHttpClientFactory(IMsalHttpClientFactory)

Menggunakan khusus IMsalHttpClientFactory untuk berkomunikasi dengan IdP. Ini memungkinkan skenario tingkat lanjut seperti mengatur proksi, atau mengatur Agen.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithInstanceDicoveryMetadata(String)
Kedaluwarsa.

Memungkinkan pengembang untuk mengonfigurasi otoritas mereka sendiri yang valid. String json yang mirip https://aka.ms/aad-instance-discovery dengan harus disediakan. MSAL menggunakan informasi ini untuk:

  • Memanggil REST API pada lingkungan yang ditentukan dalam preferred_network
  • Mengidentifikasi lingkungan tempat menyimpan token dan akun di cache
  • Gunakan alias lingkungan untuk mencocokkan token yang dikeluarkan kepada otoritas lain
Untuk detail selengkapnya lihat https://aka.ms/msal-net-custom-instance-metadata (Diperoleh dari AbstractApplicationBuilder<T>)
WithInstanceDicoveryMetadata(Uri)
Kedaluwarsa.

Memungkinkan organisasi menyiapkan layanan mereka sendiri untuk menangani penemuan instans, yang memungkinkan penembolokan yang lebih baik untuk lingkungan layanan mikro/layanan. Uri yang mengembalikan respons yang mirip https://aka.ms/aad-instance-discovery dengan yang harus disediakan. MSAL menggunakan informasi ini untuk:

  • Memanggil REST API pada lingkungan yang ditentukan dalam preferred_network
  • Mengidentifikasi lingkungan tempat menyimpan token dan akun di cache
  • Gunakan alias lingkungan untuk mencocokkan token yang dikeluarkan kepada otoritas lain
Untuk detail selengkapnya lihat https://aka.ms/msal-net-custom-instance-metadata (Diperoleh dari AbstractApplicationBuilder<T>)
WithInstanceDiscovery(Boolean)

Menentukan apakah penemuan instans dilakukan atau tidak saat mencoba mengautentikasi. Mengatur ini ke false akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Namun, ini tidak akan memengaruhi perilaku aplikasi yang dikonfigurasi dengan titik akhir regional.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithInstanceDiscoveryMetadata(String)

Memungkinkan pengembang untuk mengonfigurasi otoritas mereka sendiri yang valid. String json yang mirip https://aka.ms/aad-instance-discovery dengan harus disediakan. MSAL menggunakan informasi ini untuk:

  • Memanggil REST API pada lingkungan yang ditentukan dalam preferred_network
  • Mengidentifikasi lingkungan tempat menyimpan token dan akun di cache
  • Gunakan alias lingkungan untuk mencocokkan token yang dikeluarkan kepada otoritas lain
Untuk detail selengkapnya lihat https://aka.ms/msal-net-custom-instance-metadata (Diperoleh dari AbstractApplicationBuilder<T>)
WithInstanceDiscoveryMetadata(Uri)

Memungkinkan organisasi menyiapkan layanan mereka sendiri untuk menangani penemuan instans, yang memungkinkan penembolokan yang lebih baik untuk lingkungan layanan mikro/layanan. Uri yang mengembalikan respons yang mirip https://aka.ms/aad-instance-discovery dengan yang harus disediakan. MSAL menggunakan informasi ini untuk:

  • Memanggil REST API pada lingkungan yang ditentukan dalam preferred_network
  • Mengidentifikasi lingkungan tempat menyimpan token dan akun di cache
  • Gunakan alias lingkungan untuk mencocokkan token yang dikeluarkan kepada otoritas lain
Untuk detail selengkapnya lihat https://aka.ms/msal-net-custom-instance-metadata (Diperoleh dari AbstractApplicationBuilder<T>)
WithLegacyCacheCompatibility(Boolean)

Mengaktifkan serialisasi dan deserialisasi cache ADAL warisan.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithLogging(IIdentityLogger, Boolean)

Mengatur Pencatat Identitas. Untuk detailnya lihat https://aka.ms/msal-net-logging

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>)

Mengatur panggilan balik pengelogan. Untuk detailnya lihat https://aka.ms/msal-net-logging

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithOidcAuthority(String)

Menambahkan otoritas yang diketahui yang sesuai dengan Penyedia Identitas OpenIdConnect generik. MSAL akan menambahkan ".well-known/openid-configuration" ke otoritas dan mengambil metadata OIDC dari sana, untuk mencari tahu titik akhir. Lihat https://openid.net/specs/openid-connect-core-1_0.html#Terminology

WithOptions(ApplicationOptions)

Mengatur opsi aplikasi, yang dapat, misalnya telah dibaca dari file konfigurasi. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithOptions(BaseApplicationOptions)

Mengatur opsi aplikasi, yang dapat, misalnya telah dibaca dari file konfigurasi. Lihat https://aka.ms/msal-net-application-configuration.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
WithRedirectUri(String)

Mengatur URI pengalihan aplikasi. URI juga harus terdaftar di portal aplikasi. Lihat https://aka.ms/msal-net-application-configuration

(Diperoleh dari AbstractApplicationBuilder<T>)
WithTelemetry(ITelemetryConfig)
Kedaluwarsa.

Hasilkan peristiwa agregasi telemetri.

(Diperoleh dari AbstractApplicationBuilder<T>)
WithTelemetryClient(ITelemetryClient[])
Kedaluwarsa.

Metode ini usang. Lihat https://aka.ms/msal-net-telemetry

WithTenantId(String)

Mengatur ID penyewa organisasi tempat aplikasi akan memungkinkan pengguna masuk. Ini adalah GUID atau nama domain secara klasifikasi. Lihat https://aka.ms/msal-net-application-configuration. Meskipun dimungkinkan juga untuk mengatur tenantId ke common, organizations, dan consumers, disarankan untuk menggunakan salah satu penimpaan WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean).

(Diperoleh dari AbstractApplicationBuilder<T>)

Metode Ekstensi

Nama Deskripsi
OnCompletion(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task>)

Mengonfigurasi panggilan balik asinkron yang dipanggil saat permintaan akuisisi token selesai. Panggilan balik ini dipanggil sekali per AcquireTokenForClient panggilan, setelah semua upaya coba lagi habis. Meskipun dinamai OnCompletion untuk kasus umum, panggilan balik ini diaktifkan untuk akuisisi yang berhasil dan gagal. Ini memungkinkan skenario seperti telemetri, pengelogan, dan penanganan hasil kustom.

OnMsalServiceFailure(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task<Boolean>>)

Mengonfigurasi panggilan balik asinkron yang dipanggil saat MSAL menerima respons kesalahan dari penyedia identitas (Layanan Token Keamanan). Panggilan balik menentukan apakah MSAL harus mencoba kembali permintaan token atau menyebarluaskan pengecualian. Panggilan balik ini dipanggil setelah setiap kegagalan layanan dan dapat dipanggil beberapa kali hingga kembali false atau permintaan berhasil.

WithAppTokenProvider(ConfidentialClientApplicationBuilder, Func<AppTokenProviderParameters,Task<AppTokenProviderResult>>)

Memungkinkan pengaturan panggilan balik yang mengembalikan token akses, berdasarkan parameter yang diteruskan. MSAL akan meneruskan parameter autentikasinya ke panggilan balik dan diharapkan bahwa panggilan balik akan membangun AppTokenProviderResult dan mengembalikannya ke MSAL. MSAL akan menyimpan respons token dengan cara yang sama seperti yang dilakukannya untuk hasil autentikasi lainnya.

WithCertificate(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,Task<X509Certificate2>>, CertificateOptions)

Mengonfigurasi panggilan balik asinkron untuk memberikan sertifikat kredensial klien secara dinamis. Panggilan balik dipanggil sebelum setiap permintaan akuisisi token ke penyedia identitas (termasuk percobaan ulang). Ini memungkinkan skenario seperti rotasi sertifikat dan pemilihan sertifikat dinamis berdasarkan konteks aplikasi.

WithCertificate(ConfidentialClientApplicationBuilder, X509Certificate2, Boolean, Boolean)

Mengatur sertifikat yang terkait dengan aplikasi. Hanya berlaku untuk aplikasi pihak pertama, metode ini juga memungkinkan untuk menentukan apakah klaim x5c harus dikirim ke Azure AD. Mengirim x5c memungkinkan pengembang aplikasi untuk mencapai roll-over sertifikat yang mudah di Azure AD: metode ini akan mengirim rantai sertifikat ke Azure AD bersama dengan permintaan token, sehingga Azure AD dapat menggunakannya untuk memvalidasi nama subjek berdasarkan kebijakan penerbit tepercaya. Ini menyimpan admin aplikasi dari kebutuhan untuk mengelola rollover sertifikat secara eksplisit (baik melalui portal atau operasi PowerShell/CLI). Untuk detailnya, lihat https://aka.ms/msal-net-sni API ini memungkinkan Anda mengaitkan token yang diperoleh dari Azure AD dengan nomor seri sertifikat. Ini dapat digunakan untuk mempartisi cache menurut sertifikat. Token yang diperoleh dengan satu sertifikat tidak akan dapat diakses oleh sertifikat lain dengan nomor seri yang berbeda.

Berlaku untuk