ConfidentialClientApplicationBuilder 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 class ConfidentialClientApplicationBuilder : Microsoft.Identity.Client.AbstractApplicationBuilder<Microsoft.Identity.Client.ConfidentialClientApplicationBuilder>
type ConfidentialClientApplicationBuilder = class
inherit AbstractApplicationBuilder<ConfidentialClientApplicationBuilder>
Public Class ConfidentialClientApplicationBuilder
Inherits AbstractApplicationBuilder(Of ConfidentialClientApplicationBuilder)
- Dědičnost
-
ConfidentialClientApplicationBuilder
Metody
| Name | Description |
|---|---|
| Build() |
Vytvoří instanci IConfidentialClientApplication z parametrů nastavených v objektu ConfidentialClientApplicationBuilder. |
| Create(String) |
Vytvoří DůvěrnéClientApplicationBuilder z ID klienta. Viz https://aka.ms/msal-net-application-configuration. |
| CreateWithApplicationOptions(ConfidentialClientApplicationOptions) |
Konstruktor DůvěrnéClientApplicationBuilder z možností konfigurace aplikace. Viz https://aka.ms/msal-net-application-configuration. |
| 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>) |
| WithAzureRegion(String) |
Dává službě MSAL pokyn, aby používal službu Azure regionálního tokenu. Tato funkce je aktuálně dostupná jenom pro aplikace první strany. |
| 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>) |
| 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>) |
| WithCacheSynchronization(Boolean) |
Při nastavení |
| WithCertificate(X509Certificate2, Boolean) |
Nastaví certifikát přidružený k aplikaci. Tato metoda také umožňuje určit, jestli se má deklarace identity x5c odeslat do Azure AD. Odeslání x5c umožňuje vývojářům aplikací dosáhnout snadného vrácení certifikátu v Azure AD: tato metoda odešle řetěz certifikátů do Azure AD spolu s žádostí o token, aby ji Azure AD mohla použít k ověření názvu subjektu na základě zásad důvěryhodného vystavitele. Tím se správce aplikace uloží z nutnosti explicitně spravovat vrácení certifikátu (prostřednictvím portálu nebo operace PowerShellu nebo rozhraní příkazového řádku). Podrobnosti najdete v tématu https://aka.ms/msal-net-sni |
| WithCertificate(X509Certificate2, CertificateOptions) |
Nastaví certifikát přidružený k aplikaci. Tato metoda také umožňuje určit, jestli se má deklarace identity x5c odeslat do Azure AD. Odeslání x5c umožňuje vývojářům aplikací dosáhnout snadného vrácení certifikátu v Azure AD: tato metoda odešle řetěz certifikátů do Azure AD spolu s žádostí o token, aby ji Azure AD mohla použít k ověření názvu subjektu na základě zásad důvěryhodného vystavitele. Tím se správce aplikace uloží z nutnosti explicitně spravovat vrácení certifikátu (prostřednictvím portálu nebo operace PowerShellu nebo rozhraní příkazového řádku). Podrobnosti najdete v tématu https://aka.ms/msal-net-sni |
| WithCertificate(X509Certificate2) |
Nastaví certifikát přidružený k aplikaci. |
| WithClientAssertion(Func<AssertionRequestOptions,CancellationToken,Task<ClientSignedAssertion>>) |
Nakonfiguruje klientskou aplikaci tak, aby pro ověřování používala klientský kontrolní výraz. |
| WithClientAssertion(Func<AssertionRequestOptions,Task<String>>) |
Nakonfiguruje asynchronního delegáta, který vytvoří klientský kontrolní výraz. Delegát je vyvolán pouze v případech, kdy token nelze načíst z mezipaměti. Viz https://aka.ms/msal-net-client-assertion. |
| WithClientAssertion(Func<CancellationToken,Task<String>>) |
Nakonfiguruje asynchronního delegáta, který vytvoří klientský kontrolní výraz. Viz https://aka.ms/msal-net-client-assertion. |
| WithClientAssertion(Func<String>) |
Konfiguruje delegáta, který vytvoří klientský kontrolní výraz. Viz https://aka.ms/msal-net-client-assertion. |
| WithClientAssertion(String) |
Zastaralé.
Nastaví kontrolní výraz klienta aplikace. Viz https://aka.ms/msal-net-client-assertion. Tím se vytvoří kontrolní výraz, který se bude uchovávat v paměti klientské aplikace po dobu trvání klienta. Můžete použít WithClientAssertion(Func<String>) k nastavení delegáta, který se spustí pro každou žádost o ověření. To vám umožní aktualizovat kontrolní výraz klienta používaný klientskou aplikací po vypršení platnosti kontrolního výrazu. |
| 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>) |
| WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean, Boolean) |
Zastaralé.
Nastaví certifikát přidružený k aplikaci spolu s konkrétními deklaracemi identity, které se mají podepsat.
Ve výchozím nastavení se sloučí |
| WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean) |
Zastaralé.
Nastaví certifikát přidružený k aplikaci spolu s konkrétními deklaracemi identity, které se mají podepsat.
Ve výchozím nastavení se sloučí |
| 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>) |
| WithClientSecret(String) |
Nastaví tajný klíč aplikace. |
| 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>) |
| 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>) |
| WithGenericAuthority(String) |
Zastaralé.
Místo toho zavolejte WithOidcAuthority(String) . |
| 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:
|
| 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>) |
| 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>) |
| 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>) |
| WithTelemetryClient(ITelemetryClient[]) |
Zastaralé.
Tato metoda je zastaralá. Viz https://aka.ms/msal-net-telemetry. |
| 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 |
Metody rozšíření
| Name | Description |
|---|---|
| OnCompletion(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task>) |
Nakonfiguruje asynchronní zpětné volání, které se vyvolá při dokončení žádosti o získání tokenu.
Toto zpětné volání se vyvolá jednou za |
| OnMsalServiceFailure(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task<Boolean>>) |
Nakonfiguruje asynchronní zpětné volání, které se vyvolá, když služba MSAL obdrží chybovou odpověď od zprostředkovatele identity (služba tokenů zabezpečení).
Zpětné volání určuje, jestli má knihovna MSAL opakovat požadavek na token nebo rozšířit výjimku.
Toto zpětné volání se vyvolá po každém selhání služby a může se volat několikrát, dokud se požadavek nevrátí |
| WithAppTokenProvider(ConfidentialClientApplicationBuilder, Func<AppTokenProviderParameters,Task<AppTokenProviderResult>>) |
Umožňuje nastavit zpětné volání, které vrátí přístupový token na základě předaných parametrů. MSAL předá své ověřovací parametry zpětnému volání a očekává se, že zpětné volání vytvoří AppTokenProviderResult a vrátí ho do knihovny MSAL. MsAL uloží odpověď tokenu do mezipaměti stejným způsobem jako u jiných výsledků ověřování. |
| WithCertificate(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,Task<X509Certificate2>>, CertificateOptions) |
Nakonfiguruje asynchronní zpětné volání tak, aby dynamicky poskytoval certifikát přihlašovacích údajů klienta. Zpětné volání se vyvolá před každým požadavkem na získání tokenu pro zprostředkovatele identity (včetně opakování). To umožňuje scénáře, jako je obměny certifikátů a výběr dynamického certifikátu na základě kontextu aplikace. |
| WithCertificate(ConfidentialClientApplicationBuilder, X509Certificate2, Boolean, Boolean) |
Nastaví certifikát přidružený k aplikaci. Tato metoda také umožňuje určit, jestli se má deklarace identity x5c odeslat do Azure AD. Odeslání x5c umožňuje vývojářům aplikací dosáhnout snadného vrácení certifikátu v Azure AD: tato metoda odešle řetěz certifikátů do Azure AD spolu s žádostí o token, aby ji Azure AD mohla použít k ověření názvu subjektu na základě zásad důvěryhodného vystavitele. Tím se správce aplikace uloží z nutnosti explicitně spravovat vrácení certifikátu (prostřednictvím portálu nebo operace PowerShellu nebo rozhraní příkazového řádku). Podrobnosti najdete v části https://aka.ms/msal-net-sni Toto rozhraní API umožňuje přidružit tokeny získané z Azure AD k sériovému číslu certifikátu. Můžete ho použít k rozdělení mezipaměti podle certifikátu. Tokeny získané pomocí jednoho certifikátu nebudou přístupné jinému certifikátu s jiným sériovým číslem. |