PublicClientApplicationBuilder Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
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)- Arv
-
PublicClientApplicationBuilder
Metoder
| Name | Description | |||
|---|---|---|---|---|
| Build() |
Skapar en instans av IPublicClientApplication från parametrarna som anges i PublicClientApplicationBuilder. |
|||
| Create(String) |
Skapar en PublicClientApplicationBuilder från ett clientID. Se https://aka.ms/msal-net-application-configuration |
|||
| CreateWithApplicationOptions(PublicClientApplicationOptions) |
Skapar en PublicClientApplicationBuilder från konfigurationsalternativ för offentliga klientprogram. Se https://aka.ms/msal-net-application-configuration |
|||
| IsBrokerAvailable() |
Returnerar |
|||
| WithAdfsAuthority(String, Boolean) |
Lägger till en känd utfärdare som motsvarar en ADFS-server. Se https://aka.ms/msal-net-adfs (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AadAuthorityAudience, Boolean) |
Lägger till en känd Azure AD-utfärdare till programmet för inloggningsanvändare som anger inloggningspubliken (molnet är Azure offentliga molnet). Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Lägger till en känd Azure AD-utfärdare i programmet för inloggningsanvändare som anger molninstansen och inloggningspubliken. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program för enskild klientorganisation) som beskrivs av dess molninstans och dess klient-ID. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, String, Boolean) |
Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program med en enda klientorganisation) som beskrivs av dess molninstans och dess domännamn eller klient-ID. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Boolean) |
Lägger till en känd Azure AD-utfärdare i programmet för inloggningsanvändare som anger den fullständiga utfärdar-URI:n. Se Alternativ för programkonfiguration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Guid, Boolean) |
Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program med en enda klientorganisation) som anges av dess klientorganisations-ID. Se Alternativ för programkonfiguration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, String, Boolean) |
Lägger till en känd Azure AD-utfärdare till programmet för att logga in användare från en enda organisation (program med en enda klientorganisation) som beskrivs av dess domännamn. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithAuthority(Uri, Boolean) |
Lägger till en känd utfärdare i programmet. Se Alternativ för programkonfiguration. Den här konstruktorn används främst för scenarier där utfärdaren inte är en standardutfärdare för Azure AD, eller en ADFS-utfärdare eller en Azure AD B2C-utfärdare. För Azure AD, även i nationella moln, föredrar du att använda andra åsidosättningar somWithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithB2CAuthority(String) |
Lägger till en känd utfärdare som motsvarar en Azure AD B2C-princip. Se https://aka.ms/msal-net-b2c-specificities (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithBroker(Boolean) | ||||
| WithCacheOptions(CacheOptions) |
Alternativ för MSAL-tokencacheminnen. MSAL underhåller en tokencache internt i minnet. Som standard är det här cacheobjektet en del av varje instans av PublicClientApplication eller ConfidentialClientApplication. Den här metoden tillåter anpassning av minnesintern tokencache för MSAL. MSAL:s minnescachen skiljer sig från tokencachens serialisering. Cache-serialisering hämtar token från en cache (t.ex. Redis, Cosmos eller en fil på disk), där de lagras i JSON-format, till MSAL:s interna minnescachen. Minnescacheåtgärder omfattar inte JSON-åtgärder. Extern cache-serialisering är fortfarande det rekommenderade sättet att hantera skrivbordsappar, webbplatser och webb-API:er, eftersom det ger beständighet. De här alternativen styr för närvarande inte extern cache-serialisering. Detaljerad vägledning för varje programtyp och plattform: https://aka.ms/msal-net-token-cache-serialization (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithClientCapabilities(IEnumerable<String>) |
Microsoft identitetsspecifikt OIDC-tillägg som gör att resursutmaningar kan lösas utan interaktion. Tillåter konfiguration av en eller flera klientfunktioner, t.ex. "llt" (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithClientId(String) |
Anger klient-ID för programmet (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithClientName(String) |
Anger namnet på det anropande SDK-API:et i telemetrisyfte. (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithClientVersion(String) |
Anger versionen av anropande SDK för telemetriändamål. (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithDebugLoggingCallback(LogLevel, Boolean, Boolean) |
Anger återanropet för felsökningsloggning till en standardmetod för felsökning som visar nivån på meddelandet och själva meddelandet. Mer information finns i https://aka.ms/msal-net-logging (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithDefaultRedirectUri() |
Konfigurerar det offentliga klientprogrammet för att använda den rekommenderade svars-URI:n för plattformen. Se även https://aka.ms/msal-net-default-reply-uri.
|
|||
| WithExperimentalFeatures(Boolean) |
Tillåter användning av experimentella funktioner och API:er. Om den här flaggan inte har angetts utlöser experimentella funktioner ett undantag. Mer information finns i https://aka.ms/msal-net-experimental-features (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,String>) |
Föråldrad.
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran med kontroll över vilka parametrar som ingår i cachenyckeln (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(String) |
Föråldrad.
Anger extra frågeparametrar för frågesträngen i HTTP-autentiseringsbegäran (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory, Boolean) |
Använder en specifik IMsalHttpClientFactory för att kommunicera med IdP. Detta möjliggör avancerade scenarier som att ange en proxy eller ange agenten. (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory) |
Använder en specifik IMsalHttpClientFactory för att kommunicera med IdP. Detta möjliggör avancerade scenarier som att ange en proxy eller ange agenten. (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithInstanceDicoveryMetadata(String) |
Föråldrad.
Gör att utvecklare kan konfigurera sina egna giltiga myndigheter. En json-sträng som liknar https://aka.ms/aad-instance-discovery bör anges. MSAL använder den här informationen för att:
|
|||
| WithInstanceDicoveryMetadata(Uri) |
Föråldrad.
Låter en organisation konfigurera sin egen tjänst för att hantera instansidentifiering, vilket möjliggör bättre cachelagring för mikrotjänst-/tjänstmiljöer. En URI som returnerar ett svar som liknar https://aka.ms/aad-instance-discovery bör anges. MSAL använder den här informationen för att:
|
|||
| WithInstanceDiscovery(Boolean) |
Avgör om instansidentifiering utförs när du försöker autentisera. Om du ställer in detta på false inaktiveras helt identifiering av instanser och verifiering av utfärdare. Detta påverkar dock inte beteendet för program som konfigurerats med regionala slutpunkter. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithInstanceDiscoveryMetadata(String) |
Gör att utvecklare kan konfigurera sina egna giltiga myndigheter. En json-sträng som liknar https://aka.ms/aad-instance-discovery bör anges. MSAL använder den här informationen för att:
|
|||
| WithInstanceDiscoveryMetadata(Uri) |
Låter en organisation konfigurera sin egen tjänst för att hantera instansidentifiering, vilket möjliggör bättre cachelagring för mikrotjänst-/tjänstmiljöer. En URI som returnerar ett svar som liknar https://aka.ms/aad-instance-discovery bör anges. MSAL använder den här informationen för att:
|
|||
| WithIosKeychainSecurityGroup(String) |
Du kan ange en nyckelringsåtkomstgrupp som ska användas för att bevara tokencachen i flera program. På så sätt kan du dela tokencacheminnet mellan flera program som har samma nyckelringsåtkomstgrupp. Genom att dela tokencacheminnet kan du enkel inloggning mellan alla program som använder samma nyckelringsåtkomstgrupp. Mer information finns i https://aka.ms/msal-net-ios-keychain-security-group. |
|||
| WithKerberosTicketClaim(String, KerberosTicketContainer) |
Föråldrad.
Anger de parametrar som krävs för att hämta en Kerberos-biljett från Azure AD-tjänsten. |
|||
| WithLegacyCacheCompatibility(Boolean) |
Aktiverar äldre ADAL-cache-serialisering och deserialisering. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithLogging(IIdentityLogger, Boolean) |
Anger identitetsloggaren. Mer information finns i https://aka.ms/msal-net-logging (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>) |
Anger återanropet för loggning. Mer information finns i https://aka.ms/msal-net-logging (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithMultiCloudSupport(Boolean) |
Aktiverar stöd för flera moln för den här instansen av offentliga klientprogram. Det gör det möjligt för program att använda i en global myndighet för offentliga moln till biblioteket och kan fortfarande hämta token för resurser från nationella moln. |
|||
| WithOidcAuthority(String) |
Lägger till en känd utfärdare som motsvarar en allmän OpenIdConnect-identitetsprovider. MSAL lägger till ".well-known/openid-configuration" till utfärdaren och hämtar OIDC-metadata därifrån för att ta reda på slutpunkterna. Se https://openid.net/specs/openid-connect-core-1_0.html#Terminology |
|||
| WithOptions(ApplicationOptions) |
Anger programalternativ, som till exempel kan ha lästs från konfigurationsfiler. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithOptions(BaseApplicationOptions) |
Anger programalternativ, som till exempel kan ha lästs från konfigurationsfiler. Se även https://aka.ms/msal-net-application-configuration. (Ärvd från BaseAbstractApplicationBuilder<T>) |
|||
| WithParentActivityOrWindow(Func<IntPtr>) |
Anger en referens till IntPtr till ett fönster som utlöser webbläsaren som ska visas. Används för att centrera webbläsaren som dyker upp i det här fönstret. |
|||
| WithParentActivityOrWindow(Func<Object>) |
Anger en referens till ViewController (om du använder iOS), Aktivitet (om du använder Android) IWin32Window eller IntPtr (om du använder .Net Framework). Används för att anropa webbläsaren. |
|||
| WithRedirectUri(String) |
Anger programmets omdirigerings-URI. URI:n måste också vara registrerad i programportalen. Se https://aka.ms/msal-net-application-configuration (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithTelemetry(ITelemetryConfig) |
Föråldrad.
Generera telemetrisammansättningshändelser. (Ärvd från AbstractApplicationBuilder<T>) |
|||
| WithTenantId(String) |
Anger klientorganisations-ID för den organisation som programmet låter användarna logga in från. Detta är klassiskt ett GUID eller ett domännamn. Se även https://aka.ms/msal-net-application-configuration.
Även om det också är möjligt att ange |
|||
| WithWindowsBrokerOptions(WindowsBrokerOptions) |
Föråldrad.
Tillåter anpassning av Windows 10 Broker-upplevelsen. |
|||
Tilläggsmetoder
| Name | Description |
|---|---|
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Koordinatorer möjliggör enkel inloggning, enhetsidentifiering och programidentifieringsverifiering, samtidigt som säkerheten för program ökar. Använd det här API:et för att aktivera koordinatorer på skrivbordsplattformar. Mer https://aka.ms/msal-net-wam information om plattformsspecifika inställningar som krävs för att aktivera koordinatorn, till exempel omdirigerings-URI:er, finns i . |
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Brokers aktiverar enkel inloggning, enhetsidentifiering och förbättrad säkerhet. Använd det här API:et för att aktivera koordinatorer på skrivbordsplattformar. Mer https://aka.ms/msal-net-wam information om plattformsspecifika inställningar som krävs för att aktivera koordinatorn, till exempel omdirigerings-URI:er, finns i . |
| WithBrokerPreview(PublicClientApplicationBuilder, Boolean) |
Föråldrad.
Gör det möjligt för MSAL att använda Broker-flöden, som är säkrare än webbläsare. Mer information om Windows broker finns ihttps://aka.ms/msal-net-wam |
| WithDesktopFeatures(PublicClientApplicationBuilder) |
Föråldrad.
Lägger till utökat stöd för skrivbordsprogram, t.ex. CLI, WinForms WPF appar. Den support som har lagts till finns i närheten:
|
| WithSsoPolicy(PublicClientApplicationBuilder) |
Använd det här API:et för att aktivera SsoPolicy-tillämpning. Bör endast användas av Microsoft program från första part. Detta gäller endast när asynkron meddelandekö inte är aktiverat och inbäddad webbvy är det föredragna valet. Som standard stöder asynkron meddelandekö SsoPolicy, och systemwebbvy-SsoPolicy stöds också på OS-nivå. |
| WithWindowsBroker(PublicClientApplicationBuilder, Boolean) |
Föråldrad.
Aktiverar Windows broker-flöden på äldre plattformar, till exempel .NET ramverk, där dessa inte är tillgängliga i rutan med Microsoft. Identity.Client Mer information om Windows broker finns ihttps://aka.ms/msal-net-wam |
| WithWindowsDesktopFeatures(PublicClientApplicationBuilder, BrokerOptions) |
Lägger till utökat stöd för skrivbordsprogram, t.ex. CLI, WinForms WPF appar.
|
| WithWindowsEmbeddedBrowserSupport(PublicClientApplicationBuilder) |
Lägger till bättre stöd för inbäddade webbläsare i MSAL. AAD-program använder den äldre WebBrowser-kontrollen. Andra program (B2C, ADFS osv.) använder en inbäddad webbläsare baserat på Microsoft Edge -https://aka.ms/msal-net-webview2 |