PublicClientApplicationBuilder Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
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)
- Dědičnost
-
PublicClientApplicationBuilder
Metody
| Name | Description | |||
|---|---|---|---|---|
| Build() |
Vytvoří instanci IPublicClientApplication z parametrů nastavených v objektu PublicClientApplicationBuilder. |
|||
| Create(String) |
Vytvoří PublicClientApplicationBuilder z ID klienta. Viz https://aka.ms/msal-net-application-configuration. |
|||
| CreateWithApplicationOptions(PublicClientApplicationOptions) |
Vytvoří PublicClientApplicationBuilder z možností konfigurace veřejné klientské aplikace. Viz https://aka.ms/msal-net-application-configuration. |
|||
| IsBrokerAvailable() |
Vrátí |
|||
| WithAdfsAuthority(String, Boolean) |
Přidá známou autoritu odpovídající serveru ADFS. Viz https://aka.ms/msal-net-adfs. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AadAuthorityAudience, Boolean) |
Přidá do aplikace známou autoritu Azure AD, aby uživatelé přihlášení určili cílovou skupinu přihlašování (cloud je Azure veřejný cloud). Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Přidá do aplikace známou autoritu Azure AD, aby uživatelé přihlášení určili cloudovou instanci a cílovou skupinu přihlašování. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Přidá do aplikace známou autoritu Azure AD pro přihlášení uživatelů z jedné organizace (aplikace s jedním tenantem), kterou popisuje její cloudová instance a ID tenanta. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, String, Boolean) |
Přidá do aplikace známou autoritu Azure AD pro přihlášení uživatelů z jedné organizace (aplikace s jedním tenantem), kterou popisuje její cloudová instance a její název domény nebo ID tenanta. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Boolean) |
Přidá do aplikace známou Azure autoritu AD, aby uživatelé přihlášení zadali úplný identifikátor URI autority. Viz možnosti konfigurace aplikace. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Guid, Boolean) |
Přidá do aplikace známou autoritu Azure AD pro uživatele přihlašování z jedné organizace (aplikace s jedním tenantem) určenou jeho ID tenanta. Viz možnosti konfigurace aplikace. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, String, Boolean) |
Přidá do aplikace známou autoritu Azure AD pro uživatele přihlašování z jedné organizace (aplikace s jedním tenantem), kterou popisuje její název domény. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithAuthority(Uri, Boolean) |
Přidá do aplikace známou autoritu. Viz možnosti konfigurace aplikace. Tento konstruktor se používá hlavně ve scénářích, kdy autorita není standardní autoritou Azure AD ani autoritou ADFS ani Azure autoritou AD B2C. Pro Azure AD, i v suverénních cloudech, raději použijte jiné přepsání, jako je napříkladWithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithB2CAuthority(String) |
Přidá známou autoritu odpovídající zásadám Azure AD B2C. Viz https://aka.ms/msal-net-b2c-specificities. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithBroker(Boolean) | ||||
| WithCacheOptions(CacheOptions) |
Možnosti pro mezipaměti tokenů MSAL MSAL udržuje mezipaměť tokenů interně v paměti. Ve výchozím nastavení je tento objekt mezipaměti součástí každé instance PublicClientApplication nebo ConfidentialClientApplication. Tato metoda umožňuje přizpůsobení mezipaměti tokenů v paměti knihovny MSAL. Mezipaměť paměti MSAL se liší od serializace mezipaměti tokenů. Serializace mezipaměti načítá tokeny z mezipaměti (např. Redis, Cosmos nebo soubor na disku), kde jsou uložené ve formátu JSON, do mezipaměti interní paměti MSAL. Operace mezipaměti paměti nezahrnují operace JSON. Serializace externí mezipaměti zůstává doporučeným způsobem zpracování desktopových aplikací, webů a webových rozhraní API, protože zajišťuje trvalost. Tyto možnosti aktuálně neřídí serializaci externí mezipaměti. Podrobné pokyny pro jednotlivé typy aplikací a platformy: https://aka.ms/msal-net-token-cache-serialization (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithClientCapabilities(IEnumerable<String>) |
Microsoft rozšíření OIDC specifické pro identitu, které umožňuje řešení problémů s prostředky bez interakce. Umožňuje konfiguraci jedné nebo více možností klienta, například "llt". (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithClientId(String) |
Nastaví ID klienta aplikace. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithClientName(String) |
Nastaví název volajícího rozhraní API sady SDK pro účely telemetrie. (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithClientVersion(String) |
Nastaví verzi volající sady SDK pro účely telemetrie. (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithDebugLoggingCallback(LogLevel, Boolean, Boolean) |
Nastaví zpětné volání protokolování ladění na výchozí metodu ladění, která zobrazí úroveň zprávy a samotné zprávy. Podrobnosti najdete v tématu https://aka.ms/msal-net-logging (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithDefaultRedirectUri() |
Nakonfiguruje veřejnou klientskou aplikaci tak, aby používala doporučený identifikátor URI odpovědi pro platformu. Viz https://aka.ms/msal-net-default-reply-uri.
|
|||
| WithExperimentalFeatures(Boolean) |
Umožňuje používat experimentální funkce a rozhraní API. Pokud tento příznak není nastavený, experimentální funkce vyvolá výjimku. Podrobnosti najdete v tématu https://aka.ms/msal-net-experimental-features (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,String>) |
Zastaralé.
Nastaví další parametry dotazu pro řetězec dotazu v požadavku na ověření HTTP. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Nastaví další parametry dotazu pro řetězec dotazu v požadavku na ověřování HTTP s kontrolou, které parametry jsou zahrnuty do klíče mezipaměti. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(String) |
Zastaralé.
Nastaví další parametry dotazu pro řetězec dotazu v požadavku na ověření HTTP. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory, Boolean) |
Používá konkrétní IMsalHttpClientFactory komunikaci s idP. To umožňuje pokročilé scénáře, jako je nastavení proxy serveru nebo nastavení agenta. (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory) |
Používá konkrétní IMsalHttpClientFactory komunikaci s idP. To umožňuje pokročilé scénáře, jako je nastavení proxy serveru nebo nastavení agenta. (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithInstanceDicoveryMetadata(String) |
Zastaralé.
Umožňuje vývojářům konfigurovat vlastní platné autority. Měl by se poskytnout řetězec JSON podobný https://aka.ms/aad-instance-discovery sadě. MsAL používá tyto informace k:
|
|||
| WithInstanceDicoveryMetadata(Uri) |
Zastaralé.
Umožňuje organizaci nastavit vlastní službu pro zpracování zjišťování instancí, což umožňuje lepší ukládání do mezipaměti pro prostředí mikroslužeb nebo služeb. Měl by se poskytnout identifikátor URI, který vrací odpověď podobnou https://aka.ms/aad-instance-discovery této. MsAL používá tyto informace k:
|
|||
| WithInstanceDiscovery(Boolean) |
Určuje, zda se při pokusu o ověření provádí zjišťování instancí nebo ne. Nastavením této hodnoty na false se úplně zakáže zjišťování instancí a ověření autority. To ale neovlivní chování aplikace nakonfigurované s regionálními koncovými body. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithInstanceDiscoveryMetadata(String) |
Umožňuje vývojářům konfigurovat vlastní platné autority. Měl by se poskytnout řetězec JSON podobný https://aka.ms/aad-instance-discovery sadě. MsAL používá tyto informace k:
|
|||
| WithInstanceDiscoveryMetadata(Uri) |
Umožňuje organizaci nastavit vlastní službu pro zpracování zjišťování instancí, což umožňuje lepší ukládání do mezipaměti pro prostředí mikroslužeb nebo služeb. Měl by se poskytnout identifikátor URI, který vrací odpověď podobnou https://aka.ms/aad-instance-discovery této. MsAL používá tyto informace k:
|
|||
| WithIosKeychainSecurityGroup(String) |
Můžete zadat přístupovou skupinu řetězce klíčů, která se má použít k zachování mezipaměti tokenů napříč více aplikacemi. To vám umožní sdílet mezipaměť tokenů mezi několika aplikacemi, které mají stejnou přístupovou skupinu řetězce klíčů. Sdílení mezipaměti tokenů umožňuje jednotné přihlašování mezi všemi aplikacemi, které používají stejnou přístupovou skupinu řetězce klíčů. Další informace naleznete na https://aka.ms/msal-net-ios-keychain-security-group. |
|||
| WithKerberosTicketClaim(String, KerberosTicketContainer) |
Zastaralé.
Nastaví parametry potřebné k získání lístku Kerberos ze služby Azure AD. |
|||
| WithLegacyCacheCompatibility(Boolean) |
Umožňuje serializaci a deserializaci mezipaměti ADAL starší verze. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithLogging(IIdentityLogger, Boolean) |
Nastaví protokolovač identity. Podrobnosti najdete v tématu https://aka.ms/msal-net-logging (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>) |
Nastaví zpětné volání protokolování. Podrobnosti najdete v tématu https://aka.ms/msal-net-logging (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithMultiCloudSupport(Boolean) |
Umožňuje podporu více cloudů pro tuto instanci veřejné klientské aplikace. Umožňuje aplikacím používat v globální autoritě veřejného cloudu pro knihovnu a stále můžou získávat tokeny pro prostředky z suverénních cloudů. |
|||
| WithOidcAuthority(String) |
Přidá známou autoritu odpovídající obecnému zprostředkovateli identity OpenIdConnect. MSAL připojí k autoritě ".well-known/openid-configuration" a načte metadata OIDC odtud, aby bylo možné zjistit koncové body. Viz https://openid.net/specs/openid-connect-core-1_0.html#Terminology. |
|||
| WithOptions(ApplicationOptions) |
Nastaví možnosti aplikace, které můžou být například načteny z konfiguračních souborů. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithOptions(BaseApplicationOptions) |
Nastaví možnosti aplikace, které můžou být například načteny z konfiguračních souborů. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od BaseAbstractApplicationBuilder<T>) |
|||
| WithParentActivityOrWindow(Func<IntPtr>) |
Nastaví odkaz na IntPtr na okno, které aktivuje zobrazení prohlížeče. Slouží ke středu prohlížeče, který se otevře v tomto okně. |
|||
| WithParentActivityOrWindow(Func<Object>) |
Nastaví odkaz na ViewController (pokud používáte iOS), aktivitu (pokud používáte Android) IWin32Window nebo IntPtr (pokud používáte .Net Framework). Používá se k vyvolání prohlížeče. |
|||
| WithRedirectUri(String) |
Nastaví identifikátor URI přesměrování aplikace. Identifikátor URI musí být také zaregistrovaný na portálu aplikace. Viz https://aka.ms/msal-net-application-configuration. (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithTelemetry(ITelemetryConfig) |
Zastaralé.
Generování událostí agregace telemetrie (Zděděno od AbstractApplicationBuilder<T>) |
|||
| WithTenantId(String) |
Nastaví ID tenanta organizace, ze které aplikace umožní uživatelům přihlásit se. Jedná se o identifikátor GUID nebo název domény. Viz https://aka.ms/msal-net-application-configuration.
I když je také možné nastavit |
|||
| WithWindowsBrokerOptions(WindowsBrokerOptions) |
Zastaralé.
Umožňuje přizpůsobení prostředí Windows 10 Broker. |
|||
Metody rozšíření
| Name | Description |
|---|---|
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Zprostředkovatelé umožňují jednotné přihlašování, identifikaci zařízení a ověřování identifikace aplikací a současně zvyšují zabezpečení aplikací. Toto rozhraní API slouží k povolení zprostředkovatelů na desktopových platformách. Další https://aka.ms/msal-net-wam informace o nastaveních specifických pro platformu vyžadovaných k povolení zprostředkovatele, jako jsou identifikátory URI přesměrování. |
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Zprostředkovatelé umožňují jednotné přihlašování, identifikaci zařízení a lepší zabezpečení. Toto rozhraní API slouží k povolení zprostředkovatelů na desktopových platformách. Další https://aka.ms/msal-net-wam informace o nastaveních specifických pro platformu vyžadovaných k povolení zprostředkovatele, jako jsou identifikátory URI přesměrování. |
| WithBrokerPreview(PublicClientApplicationBuilder, Boolean) |
Zastaralé.
Umožňuje službě MSAL používat toky zprostředkovatele, které jsou bezpečnější než prohlížeče. Podrobnosti o Windows brokeru najdete v tématuhttps://aka.ms/msal-net-wam |
| WithDesktopFeatures(PublicClientApplicationBuilder) |
Zastaralé.
Přidává rozšířenou podporu desktopových aplikací, například rozhraní příkazového řádku, WinForms, WPF (Windows Presentation Foundation) aplikací. Přidaná podpora je kolem:
|
| WithSsoPolicy(PublicClientApplicationBuilder) |
Pomocí tohoto rozhraní API povolte vynucení SsoPolicy. Měly by být využívány pouze aplikacemi třetích stran Microsoft. To platí jenom v případě, že zprostředkovatel není povolený a vložené webové zobrazení je upřednostňovanou volbou. Ve výchozím nastavení zprostředkovatel podporuje SsoPolicy a system webview SsoPolicy je podporován také na úrovni operačního systému. |
| WithWindowsBroker(PublicClientApplicationBuilder, Boolean) |
Zastaralé.
Umožňuje Windows toky zprostředkovatelů na starších platformách, jako je .NET architektura, kde nejsou v poli s Microsoft k dispozici. Identity.Client Podrobnosti o Windows zprostředkovatele najdete v tématuhttps://aka.ms/msal-net-wam |
| WithWindowsDesktopFeatures(PublicClientApplicationBuilder, BrokerOptions) |
Přidává rozšířenou podporu desktopových aplikací, například rozhraní příkazového řádku, WinForms, WPF (Windows Presentation Foundation) aplikací.
|
| WithWindowsEmbeddedBrowserSupport(PublicClientApplicationBuilder) |
Přidá do knihovny MSAL lepší podporu vloženého prohlížeče. Aplikace AAD budou používat starší ovládací prvek WebBrowser. Jiné aplikace (B2C, ADFS atd.) budou používat vložený prohlížeč založený na Microsoft Edge –https://aka.ms/msal-net-webview2 |