PublicClientApplicationBuilder Kelas

Definisi

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

Metode

Nama Deskripsi
Build()

Membangun instans dari IPublicClientApplication parameter yang diatur dalam PublicClientApplicationBuilder.

Create(String)

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

CreateWithApplicationOptions(PublicClientApplicationOptions)

Membuat PublicClientApplicationBuilder dari opsi konfigurasi aplikasi klien publik. Lihat https://aka.ms/msal-net-application-configuration

IsBrokerAvailable()

Mengembalikan true jika broker dapat digunakan. Metode ini hanya diperlukan untuk digunakan dalam skenario seluler yang mendukung Manajemen Aplikasi Seluler. Dalam skenario lain yang didukung, gunakan WithBroker dengan sendirinya, yang akan kembali menggunakan browser jika broker tidak tersedia.

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

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

(Diperoleh dari AbstractApplicationBuilder<T>)
WithBroker(Boolean)
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>)
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>)
WithClientId(String)

Mengatur ID Klien aplikasi

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

Mengatur nama API SDK panggilan untuk tujuan telemetri.

(Diperoleh dari BaseAbstractApplicationBuilder<T>)
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>)
WithDefaultRedirectUri()

Mengonfigurasi aplikasi klien publik untuk menggunakan URI balasan yang direkomendasikan untuk platform. Lihat https://aka.ms/msal-net-default-reply-uri.

Platform
.NET desktop
Untuk browser sistem pada .NET Core
CATATAN: Akan ada pembaruan untuk URI pengalihan default di masa mendatang untuk mengakomodasi browser sistem di desktop .NET dan platform .NET Core.
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>)
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>)
WithIosKeychainSecurityGroup(String)

Anda dapat menentukan Grup Akses Rantai Kunci yang akan digunakan untuk mempertahankan cache token di beberapa aplikasi. Ini memungkinkan Anda berbagi cache token antara beberapa aplikasi yang memiliki grup akses Rantai Kunci yang sama. Berbagi cache token memungkinkan akses menyeluruh antara semua aplikasi yang menggunakan Grup akses Rantai Kunci yang sama. Lihat https://aka.ms/msal-net-ios-keychain-security-group untuk informasi lebih lanjut.

WithKerberosTicketClaim(String, KerberosTicketContainer)
Kedaluwarsa.

Mengatur parameter yang diperlukan untuk mendapatkan Tiket Kerberos dari layanan Azure AD.

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

Mengaktifkan dukungan multi cloud untuk instans aplikasi klien publik ini. Ini memungkinkan aplikasi untuk digunakan dalam otoritas cloud publik global ke pustaka dan masih bisa mendapatkan token untuk sumber daya dari sovereign cloud.

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>)
WithParentActivityOrWindow(Func<IntPtr>)

Mengatur referensi ke IntPtr ke jendela yang memicu browser untuk ditampilkan. Digunakan untuk memusatkan browser yang muncul ke jendela ini.

WithParentActivityOrWindow(Func<Object>)

Mengatur referensi ke ViewController (jika menggunakan iOS), Aktivitas (jika menggunakan Android) IWin32Window atau IntPtr (jika menggunakan .Net Framework). Digunakan untuk memanggil browser.

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>)
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>)
WithWindowsBrokerOptions(WindowsBrokerOptions)
Kedaluwarsa.

Memungkinkan penyesuaian pengalaman Windows 10 Broker.

Metode Ekstensi

Nama Deskripsi
WithBroker(PublicClientApplicationBuilder, BrokerOptions)

Broker mengaktifkan Akses Menyeluruh, identifikasi perangkat, dan verifikasi identifikasi aplikasi, sambil meningkatkan keamanan aplikasi. Gunakan API ini untuk mengaktifkan broker di platform desktop.

Lihat https://aka.ms/msal-net-wam untuk informasi selengkapnya tentang pengaturan spesifik platform yang diperlukan untuk mengaktifkan broker seperti URI pengalihan.

WithBroker(PublicClientApplicationBuilder, BrokerOptions)

Broker mengaktifkan Akses Menyeluruh, identifikasi perangkat, dan keamanan yang ditingkatkan. Gunakan API ini untuk mengaktifkan broker di platform desktop.

Lihat https://aka.ms/msal-net-wam untuk informasi selengkapnya tentang pengaturan spesifik platform yang diperlukan untuk mengaktifkan broker seperti URI pengalihan.

WithBrokerPreview(PublicClientApplicationBuilder, Boolean)
Kedaluwarsa.

Memungkinkan MSAL untuk menggunakan alur Broker, yang lebih aman daripada browser. Untuk detail tentang broker Windows, lihathttps://aka.ms/msal-net-wam

WithDesktopFeatures(PublicClientApplicationBuilder)
Kedaluwarsa.

Menambahkan dukungan yang ditingkatkan untuk aplikasi desktop, misalnya CLI, WinForms, WPF aplikasi.

Dukungan yang ditambahkan ada di sekitar:

WithSsoPolicy(PublicClientApplicationBuilder)

Gunakan API ini untuk mengaktifkan penegakan SsoPolicy. Hanya boleh digunakan oleh aplikasi pihak ke-1 Microsoft. Ini hanya berlaku ketika broker tidak diaktifkan dan tampilan web yang disematkan adalah pilihan yang disukai. Secara default, broker mendukung SsoPolicy, dan SsoPolicy webview sistem juga didukung di tingkat OS.

WithWindowsBroker(PublicClientApplicationBuilder, Boolean)
Kedaluwarsa.

Memungkinkan Windows alur broker pada platform yang lebih lama, seperti kerangka kerja .NET, di mana ini tidak tersedia di kotak dengan Microsoft. Identity.Client Untuk detail tentang broker Windows, lihathttps://aka.ms/msal-net-wam

WithWindowsDesktopFeatures(PublicClientApplicationBuilder, BrokerOptions)

Menambahkan dukungan yang ditingkatkan untuk aplikasi desktop, misalnya CLI, WinForms, WPF aplikasi.

  • broker Windows Authentication Manager (WAM), mekanisme autentikasi yang direkomendasikan pada Windows 10+ -https://aka.ms/msal-net-wam
  • Tampilan web yang disematkan. Aplikasi AAD menggunakan kontrol WebBrowser yang lebih lama. Aplikasi lain (B2C, ADFS dll.) menggunakan WebView2, browser yang disematkan berdasarkan Microsoft Edge -https://aka.ms/msal-net-webview2
WithWindowsEmbeddedBrowserSupport(PublicClientApplicationBuilder)

Menambahkan dukungan browser yang disematkan dengan lebih baik ke MSAL. Aplikasi AAD akan menggunakan kontrol WebBrowser yang lebih lama. Aplikasi lain (B2C, ADFS dll.) akan menggunakan browser yang disematkan berdasarkan Microsoft Edge -https://aka.ms/msal-net-webview2

Berlaku untuk