PublicClientApplicationBuilder Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
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)- Herencia
-
PublicClientApplicationBuilder
Métodos
| Nombre | Description | |||
|---|---|---|---|---|
| Build() |
Compila una instancia de a partir de IPublicClientApplication los parámetros establecidos en .PublicClientApplicationBuilder |
|||
| Create(String) |
Crea un publicClientApplicationBuilder a partir de un clientID. Vea https://aka.ms/msal-net-application-configuration. |
|||
| CreateWithApplicationOptions(PublicClientApplicationOptions) |
Crea un publicClientApplicationBuilder a partir de las opciones de configuración de aplicaciones cliente públicas. Vea https://aka.ms/msal-net-application-configuration. |
|||
| IsBrokerAvailable() |
Devuelve |
|||
| WithAdfsAuthority(String, Boolean) |
Agrega una entidad conocida correspondiente a un servidor ADFS. Vea https://aka.ms/msal-net-adfs. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AadAuthorityAudience, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación para iniciar sesión a los usuarios que especifican el público de inicio de sesión (la nube es la nube Azure nube pública). Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación para iniciar sesión a los usuarios que especifican la instancia de nube y la audiencia de inicio de sesión. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación a los usuarios de inicio de sesión desde una sola organización (aplicación de inquilino único) descrita por su instancia de nube y su identificador de inquilino. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, String, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación para iniciar sesión a los usuarios de una sola organización (aplicación de inquilino único) descrita por su instancia de nube y su nombre de dominio o identificador de inquilino. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación para iniciar sesión a los usuarios que especifican el URI de autoridad completa. Consulte Opciones de configuración de la aplicación. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Guid, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación para iniciar sesión a los usuarios de una sola organización (aplicación de inquilino único) especificada por su identificador de inquilino. Consulte Opciones de configuración de la aplicación. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, String, Boolean) |
Agrega una entidad de Azure AD conocida a la aplicación a los usuarios de inicio de sesión desde una sola organización (aplicación de inquilino único) descrita por su nombre de dominio. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithAuthority(Uri, Boolean) |
Agrega una autoridad conocida a la aplicación. Consulte Opciones de configuración de la aplicación. Este constructor se usa principalmente para escenarios en los que la autoridad no es una autoridad de AD estándar Azure, ni una autoridad de ADFS, ni una autoridad de Azure AD B2C. Para Azure AD, incluso en nubes soberanas, prefiere usar otras invalidaciones, comoWithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithB2CAuthority(String) |
Agrega una autoridad conocida correspondiente a una directiva de Azure AD B2C. Vea https://aka.ms/msal-net-b2c-specificities. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithBroker(Boolean) | ||||
| WithCacheOptions(CacheOptions) |
Opciones para las cachés de tokens de MSAL. MSAL mantiene una caché de tokens internamente en la memoria. De forma predeterminada, este objeto de caché forma parte de cada instancia de PublicClientApplication o ConfidentialClientApplication. Este método permite personalizar la caché de tokens en memoria de MSAL. La caché de memoria de MSAL es diferente de la serialización de caché de tokens. La serialización de caché extrae los tokens de una memoria caché (por ejemplo, Redis, Cosmos o un archivo en disco), donde se almacenan en formato JSON, en la caché de memoria interna de MSAL. Las operaciones de caché de memoria no implican operaciones JSON. La serialización de caché externa sigue siendo la manera recomendada de controlar las aplicaciones de escritorio, el sitio web y las API web, ya que proporciona persistencia. Estas opciones no controlan actualmente la serialización de caché externa. Instrucciones detalladas para cada tipo de aplicación y plataforma: https://aka.ms/msal-net-token-cache-serialization (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithClientCapabilities(IEnumerable<String>) |
Microsoft extensión OIDC específica de identidad que permite resolver los desafíos de recursos sin interacción. Permite la configuración de una o varias funcionalidades de cliente, por ejemplo, "llt" (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithClientId(String) |
Establece el identificador de cliente de la aplicación. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithClientName(String) |
Establece el nombre de la API del SDK que llama con fines de telemetría. (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithClientVersion(String) |
Establece la versión del SDK de llamada con fines de telemetría. (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithDebugLoggingCallback(LogLevel, Boolean, Boolean) |
Establece la devolución de llamada de registro de depuración en un método de depuración predeterminado que muestra el nivel del mensaje y el propio mensaje. Para obtener más información, consulte https://aka.ms/msal-net-logging (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithDefaultRedirectUri() |
Configura la aplicación cliente pública para usar el URI de respuesta recomendado para la plataforma. Consulte https://aka.ms/msal-net-default-reply-uri.
|
|||
| WithExperimentalFeatures(Boolean) |
Permite el uso de características y API experimentales. Si no se establece esta marca, las características experimentales producirán una excepción. Para obtener más información, consulte https://aka.ms/msal-net-experimental-features (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,String>) |
Obsoletos.
Establece parámetros de consulta adicionales para la cadena de consulta en la solicitud de autenticación HTTP. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Establece parámetros de consulta adicionales para la cadena de consulta en la solicitud de autenticación HTTP con control sobre qué parámetros se incluyen en la clave de caché. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(String) |
Obsoletos.
Establece parámetros de consulta adicionales para la cadena de consulta en la solicitud de autenticación HTTP. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory, Boolean) |
Usa un elemento específico IMsalHttpClientFactory para comunicarse con el IdP. Esto habilita escenarios avanzados, como establecer un proxy o establecer el Agente. (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory) |
Usa un elemento específico IMsalHttpClientFactory para comunicarse con el IdP. Esto habilita escenarios avanzados, como establecer un proxy o establecer el Agente. (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithInstanceDicoveryMetadata(String) |
Obsoletos.
Permite a los desarrolladores configurar sus propias autoridades válidas. Se debe proporcionar una cadena json similar a https://aka.ms/aad-instance-discovery . MSAL usa esta información para:
|
|||
| WithInstanceDicoveryMetadata(Uri) |
Obsoletos.
Permite a una organización configurar su propio servicio para controlar la detección de instancias, lo que permite un mejor almacenamiento en caché para los entornos de microservicios y servicios. Se debe proporcionar un URI que devuelva una respuesta similar a https://aka.ms/aad-instance-discovery . MSAL usa esta información para:
|
|||
| WithInstanceDiscovery(Boolean) |
Determina si se realiza o no la detección de instancias al intentar autenticarse. Si se establece en false, se deshabilitará completamente la detección de instancias y la validación de la autoridad. Sin embargo, esto no afectará al comportamiento de la aplicación configurada con puntos de conexión regionales. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithInstanceDiscoveryMetadata(String) |
Permite a los desarrolladores configurar sus propias autoridades válidas. Se debe proporcionar una cadena json similar a https://aka.ms/aad-instance-discovery . MSAL usa esta información para:
|
|||
| WithInstanceDiscoveryMetadata(Uri) |
Permite a una organización configurar su propio servicio para controlar la detección de instancias, lo que permite un mejor almacenamiento en caché para los entornos de microservicios y servicios. Se debe proporcionar un URI que devuelva una respuesta similar a https://aka.ms/aad-instance-discovery . MSAL usa esta información para:
|
|||
| WithIosKeychainSecurityGroup(String) |
Puede especificar un grupo de acceso de cadena de claves que se usará para conservar la caché de tokens en varias aplicaciones. Esto le permite compartir la caché de tokens entre varias aplicaciones que tienen el mismo grupo de acceso a llaveros. El uso compartido de la caché de tokens permite el inicio de sesión único entre todas las aplicaciones que usan el mismo grupo de acceso a llaves. Consulte https://aka.ms/msal-net-ios-keychain-security-group para obtener más información. |
|||
| WithKerberosTicketClaim(String, KerberosTicketContainer) |
Obsoletos.
Establece los parámetros necesarios para obtener un vale kerberos de Azure servicio de AD. |
|||
| WithLegacyCacheCompatibility(Boolean) |
Habilita la serialización y deserialización de caché de ADAL heredadas. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithLogging(IIdentityLogger, Boolean) |
Establece el registrador de identidades. Para obtener más información, consulte https://aka.ms/msal-net-logging (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>) |
Establece la devolución de llamada de registro. Para obtener más información, consulte https://aka.ms/msal-net-logging (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithMultiCloudSupport(Boolean) |
Habilita la compatibilidad con varias nubes para esta instancia de la aplicación cliente pública. Permite que las aplicaciones se usen en una entidad de nube pública global en la biblioteca y todavía pueden obtener tokens para los recursos de nubes soberanas. |
|||
| WithOidcAuthority(String) |
Agrega una entidad conocida correspondiente a un proveedor de identidades de OpenIdConnect genérico. MSAL anexará ".well-known/openid-configuration" a la autoridad y recuperará los metadatos de OIDC desde allí para averiguar los puntos de conexión. Vea https://openid.net/specs/openid-connect-core-1_0.html#Terminology. |
|||
| WithOptions(ApplicationOptions) |
Establece las opciones de aplicación, que, por ejemplo, se han leído de los archivos de configuración. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithOptions(BaseApplicationOptions) |
Establece las opciones de aplicación, que, por ejemplo, se han leído de los archivos de configuración. Consulte https://aka.ms/msal-net-application-configuration. (Heredado de BaseAbstractApplicationBuilder<T>) |
|||
| WithParentActivityOrWindow(Func<IntPtr>) |
Establece una referencia a IntPtr en una ventana que desencadena el explorador que se va a mostrar. Se usa para centrar el explorador que aparece en esta ventana. |
|||
| WithParentActivityOrWindow(Func<Object>) |
Establece una referencia a ViewController (si usa iOS), Activity (si usa Android) IWin32Window o IntPtr (si usa .Net Framework). Se usa para invocar el explorador. |
|||
| WithRedirectUri(String) |
Establece el URI de redireccionamiento de la aplicación. El URI también debe estar registrado en el portal de aplicaciones. Vea https://aka.ms/msal-net-application-configuration. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithTelemetry(ITelemetryConfig) |
Obsoletos.
Genere eventos de agregación de telemetría. (Heredado de AbstractApplicationBuilder<T>) |
|||
| WithTenantId(String) |
Establece el identificador de inquilino de la organización desde la que la aplicación permitirá a los usuarios iniciar sesión. Esto es clásicamente un GUID o un nombre de dominio. Consulte https://aka.ms/msal-net-application-configuration.
Aunque también es posible establecer en |
|||
| WithWindowsBrokerOptions(WindowsBrokerOptions) |
Obsoletos.
Permite la personalización de la experiencia de agente de Windows 10. |
|||
Métodos de extensión
| Nombre | Description |
|---|---|
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Los agentes habilitan el inicio de sesión único, la identificación del dispositivo y la comprobación de identificación de aplicaciones, al tiempo que aumentan la seguridad de las aplicaciones. Use esta API para habilitar agentes en plataformas de escritorio. Consulte https://aka.ms/msal-net-wam para obtener más información sobre la configuración específica de la plataforma necesaria para habilitar el agente, como los URI de redirección. |
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
Los agentes habilitan el inicio de sesión único, la identificación del dispositivo y la seguridad mejorada. Use esta API para habilitar agentes en plataformas de escritorio. Consulte https://aka.ms/msal-net-wam para obtener más información sobre la configuración específica de la plataforma necesaria para habilitar el agente, como los URI de redirección. |
| WithBrokerPreview(PublicClientApplicationBuilder, Boolean) |
Obsoletos.
Permite que MSAL use flujos de Broker, que son más seguros que los exploradores. Para obtener más información sobre Windows agente, consultehttps://aka.ms/msal-net-wam |
| WithDesktopFeatures(PublicClientApplicationBuilder) |
Obsoletos.
Agrega compatibilidad mejorada con aplicaciones de escritorio, por ejemplo, CLI, WinForms y aplicaciones de WPF. La compatibilidad agregada está en torno a:
|
| WithSsoPolicy(PublicClientApplicationBuilder) |
Use esta API para habilitar la aplicación de SsoPolicy. Solo se debe usar en aplicaciones de Microsoft 1ª entidad. Esto solo es aplicable cuando el agente no está habilitado y la vista web insertada es la opción preferida. De forma predeterminada, el agente admite SsoPolicy y el sistema webview SsoPolicy también se admite en el nivel de sistema operativo. |
| WithWindowsBroker(PublicClientApplicationBuilder, Boolean) |
Obsoletos.
Habilita Windows flujos de agente en plataformas anteriores, como .NET framework, donde no están disponibles en el cuadro con Microsoft. Identity.Client Para obtener más información sobre Windows agente, consultehttps://aka.ms/msal-net-wam |
| WithWindowsDesktopFeatures(PublicClientApplicationBuilder, BrokerOptions) |
Agrega compatibilidad mejorada con aplicaciones de escritorio, por ejemplo, CLI, WinForms y aplicaciones de WPF.
|
| WithWindowsEmbeddedBrowserSupport(PublicClientApplicationBuilder) |
Agrega una mejor compatibilidad con el explorador insertado a MSAL. Las aplicaciones de AAD usarán el control WebBrowser anterior. Otras aplicaciones (B2C, ADFS, etc.) usarán un explorador incrustado basado en Microsoft Edge:https://aka.ms/msal-net-webview2 |