AbstractApplicationBuilder<T> Class

Definition

Namespace:

Microsoft.Identity.Client

Assembly:

Microsoft.Identity.Client.dll

Package:

Microsoft.Identity.Client v4.66.1

public abstract class AbstractApplicationBuilder<T> : Microsoft.Identity.Client.BaseAbstractApplicationBuilder<T> where T : BaseAbstractApplicationBuilder<T>

type AbstractApplicationBuilder<'T (requires 'T :> BaseAbstractApplicationBuilder<'T>)> = class
    inherit BaseAbstractApplicationBuilder<'T (requires 'T :> BaseAbstractApplicationBuilder<'T>)>

Public MustInherit Class AbstractApplicationBuilder(Of T)
Inherits BaseAbstractApplicationBuilder(Of T)

Type Parameters

T

Inheritance

Object

BaseAbstractApplicationBuilder<T>

AbstractApplicationBuilder<T>

Derived

Microsoft.Identity.Client.ConfidentialClientApplicationBuilder

Microsoft.Identity.Client.PublicClientApplicationBuilder

Methods

WithAdfsAuthority(String, Boolean)	Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs
WithAuthority(AadAuthorityAudience, Boolean)	Adds a known Azure AD authority to the application to sign-in users specifying the sign-in audience (the cloud being the Azure public cloud). See https://aka.ms/msal-net-application-configuration.
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)	Adds a known Azure AD authority to the application to sign-in users specifying the cloud instance and the sign-in audience. See https://aka.ms/msal-net-application-configuration.
WithAuthority(AzureCloudInstance, Guid, Boolean)	Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its tenant ID. See https://aka.ms/msal-net-application-configuration.
WithAuthority(AzureCloudInstance, String, Boolean)	Adds a known Azure AD authority to the application to sign-in users from a single organization (single-tenant application) described by its cloud instance and its domain name or tenant ID. See https://aka.ms/msal-net-application-configuration.
WithAuthority(String, Boolean)	Adds a known Azure AD authority to the application to sign-in users specifying the full authority URI. See Application configuration options.
WithAuthority(String, Guid, Boolean)	Adds a known Azure AD authority to the application to sign-in users from a single organization (single-tenant application) specified by its tenant ID. See Application configuration options.
WithAuthority(String, String, Boolean)	Adds a known Azure AD authority to the application to sign-in users from a single organization (single-tenant application) described by its domain name. See https://aka.ms/msal-net-application-configuration.
WithAuthority(Uri, Boolean)	Adds a known authority to the application. See Application configuration options. This constructor is mainly used for scenarios where the authority is not a standard Azure AD authority, nor an ADFS authority, nor an Azure AD B2C authority. For Azure AD, even in sovereign clouds, prefer using other overrides such as WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)
WithB2CAuthority(String)	Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities
WithCacheOptions(CacheOptions)	Options for MSAL token caches. MSAL maintains a token cache internally in memory. By default, this cache object is part of each instance of PublicClientApplication or ConfidentialClientApplication. This method allows customization of the in-memory token cache of MSAL. MSAL's memory cache is different than token cache serialization. Cache serialization pulls the tokens from a cache (e.g. Redis, Cosmos, or a file on disk), where they are stored in JSON format, into MSAL's internal memory cache. Memory cache operations do not involve JSON operations. External cache serialization remains the recommended way to handle desktop apps, web site and web APIs, as it provides persistence. These options do not currently control external cache serialization. Detailed guidance for each application type and platform: https://aka.ms/msal-net-token-cache-serialization
WithClientCapabilities(IEnumerable<String>)	Microsoft Identity specific OIDC extension that allows resource challenges to be resolved without interaction. Allows configuration of one or more client capabilities, e.g. "llt"
WithClientId(String)	Sets the Client ID of the application
WithClientName(String)	Sets the name of the calling SDK API for telemetry purposes. (Inherited from BaseAbstractApplicationBuilder<T>)
WithClientVersion(String)	Sets the version of the calling SDK for telemetry purposes. (Inherited from BaseAbstractApplicationBuilder<T>)
WithDebugLoggingCallback(LogLevel, Boolean, Boolean)	Sets the Debug logging callback to a default debug method which displays the level of the message and the message itself. For details see https://aka.ms/msal-net-logging (Inherited from BaseAbstractApplicationBuilder<T>)
WithExperimentalFeatures(Boolean)	Allows usage of experimental features and APIs. If this flag is not set, experimental features will throw an exception. For details see https://aka.ms/msal-net-experimental-features (Inherited from BaseAbstractApplicationBuilder<T>)
WithExtraQueryParameters(IDictionary<String,String>)	Sets Extra Query Parameters for the query string in the HTTP authentication request
WithExtraQueryParameters(String)	Sets Extra Query Parameters for the query string in the HTTP authentication request
WithHttpClientFactory(IMsalHttpClientFactory, Boolean)	Uses a specific IMsalHttpClientFactory to communicate with the IdP. This enables advanced scenarios such as setting a proxy, or setting the Agent. (Inherited from BaseAbstractApplicationBuilder<T>)
WithHttpClientFactory(IMsalHttpClientFactory)	Uses a specific IMsalHttpClientFactory to communicate with the IdP. This enables advanced scenarios such as setting a proxy, or setting the Agent. (Inherited from BaseAbstractApplicationBuilder<T>)
WithInstanceDicoveryMetadata(String)	Obsolete. Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: Call REST APIs on the environment specified in the preferred_network Identify an environment under which to save tokens and accounts in the cache Use the environment aliases to match tokens issued to other authorities For more details see https://aka.ms/msal-net-custom-instance-metadata
WithInstanceDicoveryMetadata(Uri)	Obsolete. Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: Call REST APIs on the environment specified in the preferred_network Identify an environment under which to save tokens and accounts in the cache Use the environment aliases to match tokens issued to other authorities For more details see https://aka.ms/msal-net-custom-instance-metadata
WithInstanceDiscovery(Boolean)	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to false will completely disable instance discovery and authority validation. This will not affect the behavior of application configured with regional endpoints however.
WithInstanceDiscoveryMetadata(String)	Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: Call REST APIs on the environment specified in the preferred_network Identify an environment under which to save tokens and accounts in the cache Use the environment aliases to match tokens issued to other authorities For more details see https://aka.ms/msal-net-custom-instance-metadata
WithInstanceDiscoveryMetadata(Uri)	Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: Call REST APIs on the environment specified in the preferred_network Identify an environment under which to save tokens and accounts in the cache Use the environment aliases to match tokens issued to other authorities For more details see https://aka.ms/msal-net-custom-instance-metadata
WithLegacyCacheCompatibility(Boolean)	Enables legacy ADAL cache serialization and deserialization.
WithLogging(IIdentityLogger, Boolean)	Sets the Identity Logger. For details see https://aka.ms/msal-net-logging (Inherited from BaseAbstractApplicationBuilder<T>)
WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>)	Sets the logging callback. For details see https://aka.ms/msal-net-logging (Inherited from BaseAbstractApplicationBuilder<T>)
WithOptions(ApplicationOptions)	Sets application options, which can, for instance have been read from configuration files. See https://aka.ms/msal-net-application-configuration.
WithOptions(BaseApplicationOptions)	Sets application options, which can, for instance have been read from configuration files. See https://aka.ms/msal-net-application-configuration. (Inherited from BaseAbstractApplicationBuilder<T>)
WithRedirectUri(String)	Sets the redirect URI of the application. The URI must also be registered in the application portal. See https://aka.ms/msal-net-application-configuration
WithTelemetry(ITelemetryConfig)	Obsolete. Generate telemetry aggregation events.
WithTenantId(String)	Sets the tenant ID of the organization from which the application will let users sign-in. This is classically a GUID or a domain name. See https://aka.ms/msal-net-application-configuration. Although it is also possible to set tenantId to common, organizations, and consumers, it's recommended to use one of the overrides of WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean).