ConfidentialClientApplicationBuilder Класс

Определение

Пространство имен:

Microsoft.Identity.Client

Сборка:

Microsoft.Identity.Client.dll

Пакет:

Microsoft.Identity.Client v4.84.2

public class ConfidentialClientApplicationBuilder : Microsoft.Identity.Client.AbstractApplicationBuilder<Microsoft.Identity.Client.ConfidentialClientApplicationBuilder>

type ConfidentialClientApplicationBuilder = class
    inherit AbstractApplicationBuilder<ConfidentialClientApplicationBuilder>

Public Class ConfidentialClientApplicationBuilder
Inherits AbstractApplicationBuilder(Of ConfidentialClientApplicationBuilder)

Наследование

Object

BaseAbstractApplicationBuilder<T>

AbstractApplicationBuilder<ConfidentialClientApplicationBuilder>

ConfidentialClientApplicationBuilder

Методы

Имя	Описание
Build()	Создает экземпляр IConfidentialClientApplication из набора параметров в объекте ConfidentialClientApplicationBuilder.
Create(String)	Создает Конфиденциальный ОбъектClientApplicationBuilder из идентификатора клиента. См. https://aka.ms/msal-net-application-configuration
CreateWithApplicationOptions(ConfidentialClientApplicationOptions)	Конструктор Объекта ConfidentialClientApplicationBuilder из параметров конфигурации приложения. См. https://aka.ms/msal-net-application-configuration
WithAdfsAuthority(String, Boolean)	Добавляет известный центр, соответствующий серверу ADFS. См. https://aka.ms/msal-net-adfs (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(AadAuthorityAudience, Boolean)	Добавляет в приложение известный центр Azure AD для пользователей входа, указывающих аудиторию входа (облако, являющееся Azure общедоступным облаком). См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)	Добавляет известный центр Azure AD в приложение для входа пользователей, указывающих облачный экземпляр и аудиторию входа. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, Guid, Boolean)	Добавляет известный центр Azure AD в приложение для входа пользователей из одной организации (однотенантного приложения), описанного его облачным экземпляром и идентификатором клиента. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(AzureCloudInstance, String, Boolean)	Добавляет известный центр Azure AD в приложение для входа пользователей из одной организации (однотенантного приложения), описанной в своем облачном экземпляре и его доменном имени или идентификаторе клиента. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(String, Boolean)	Добавляет известный Azure центр AD в приложение для входа пользователей, указывающих полный универсальный код ресурса (URI) центра. См. параметры конфигурации приложения. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(String, Guid, Boolean)	Добавляет известный центр Azure AD в приложение для входа пользователей из одной организации (однотенантного приложения), указанного его идентификатором клиента. См. параметры конфигурации приложения. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(String, String, Boolean)	Добавляет известный центр Azure AD в приложение для входа пользователей из одной организации (однотенантного приложения), описанного его доменным именем. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithAuthority(Uri, Boolean)	Добавляет известный центр в приложение. См. параметры конфигурации приложения. Этот конструктор в основном используется для сценариев, когда центр не является стандартным Azure центром AD, а также центром ADFS, а также Azure центром AD B2C. Для Azure AD, даже в национальных облаках, предпочитают использовать другие переопределения, такие какWithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) (Унаследовано от AbstractApplicationBuilder<T>)
WithAzureRegion(String)	Указывает MSAL использовать Azure региональную службу маркеров. Эта функция в настоящее время доступна только для сторонних приложений.
WithB2CAuthority(String)	Добавляет известный центр, соответствующий политике AD B2C Azure. См. https://aka.ms/msal-net-b2c-specificities (Унаследовано от AbstractApplicationBuilder<T>)
WithCacheOptions(CacheOptions)	Параметры кэша маркеров MSAL. MSAL сохраняет кэш маркеров внутри памяти. По умолчанию этот объект кэша является частью каждого экземпляра PublicClientApplication или ConfidentialClientApplication. Этот метод позволяет настраивать кэш токенов в памяти MSAL. Кэш памяти MSAL отличается от сериализации кэша маркеров. Сериализация кэша извлекает маркеры из кэша (например, Redis, Cosmos или файл на диске), где они хранятся в формате JSON, в внутренний кэш памяти MSAL. Операции кэша памяти не включают операции JSON. Сериализация внешнего кэша остается рекомендуемым способом обработки классических приложений, веб-сайтов и веб-API, так как она обеспечивает сохраняемость. Эти параметры в настоящее время не управляют сериализацией внешнего кэша. Подробные рекомендации по каждому типу приложения и платформе: https://aka.ms/msal-net-token-cache-serialization (Унаследовано от AbstractApplicationBuilder<T>)
WithCacheSynchronization(Boolean)	Если задано значение true, MSAL заблокирует доступ к кэшу на ConfidentialClientApplication уровне, то есть блок кода между BeforeAccessAsync и AfterAccessAsync обратных вызовов будет синхронизирован. Приложения могут задать этот флаг false , чтобы включить оптимистическую стратегию блокировки кэша, что может привести к повышению производительности за счет согласованности кэша. Установка этого флага false рекомендуется только для приложений, создающих новый ConfidentialClientApplication запрос.
WithCertificate(X509Certificate2, Boolean)	Задает сертификат, связанный с приложением. Применимо только к приложениям первой стороны, этот метод также позволяет указать, следует ли отправлять утверждение x5c в Azure AD. Отправка x5c позволяет разработчикам приложений выполнять простой перекат сертификатов в Azure AD: этот метод отправляет цепочку сертификатов в Azure AD вместе с запросом маркера, чтобы Azure AD мог использовать его для проверки имени субъекта на основе политики доверенного издателя. Это сохраняет администратора приложения от необходимости явно управлять переключением сертификата (с помощью портала или операции PowerShell/CLI). Дополнительные сведения см. в разделе https://aka.ms/msal-net-sni
WithCertificate(X509Certificate2, CertificateOptions)	Задает сертификат, связанный с приложением. Применимо только к приложениям первой стороны, этот метод также позволяет указать, следует ли отправлять утверждение x5c в Azure AD. Отправка x5c позволяет разработчикам приложений выполнять простой перекат сертификатов в Azure AD: этот метод отправляет цепочку сертификатов в Azure AD вместе с запросом маркера, чтобы Azure AD мог использовать его для проверки имени субъекта на основе политики доверенного издателя. Это сохраняет администратора приложения от необходимости явно управлять переключением сертификата (с помощью портала или операции PowerShell/CLI). Дополнительные сведения см. в разделе https://aka.ms/msal-net-sni
WithCertificate(X509Certificate2)	Задает сертификат, связанный с приложением.
WithClientAssertion(Func<AssertionRequestOptions,CancellationToken,Task<ClientSignedAssertion>>)	Настраивает клиентское приложение для использования утверждения клиента для проверки подлинности.
WithClientAssertion(Func<AssertionRequestOptions,Task<String>>)	Настраивает асинхронный делегат, который создает утверждение клиента. Делегат вызывается только в том случае, если маркер не может быть извлечен из кэша. См. https://aka.ms/msal-net-client-assertion
WithClientAssertion(Func<CancellationToken,Task<String>>)	Настраивает асинхронный делегат, который создает утверждение клиента. См. https://aka.ms/msal-net-client-assertion
WithClientAssertion(Func<String>)	Настраивает делегат, который создает утверждение клиента. См. https://aka.ms/msal-net-client-assertion
WithClientAssertion(String)	Устаревшие. Задает утверждение клиента приложения. См. https://aka.ms/msal-net-client-assertion. При этом будет создано утверждение, которое будет храниться в памяти клиентского приложения в течение длительности клиента. Можно использовать WithClientAssertion(Func<String>) для задания делегата, который будет выполняться для каждого запроса проверки подлинности. Это позволит обновить утверждение клиента, используемое клиентским приложением после истечения срока действия утверждения.
WithClientCapabilities(IEnumerable<String>)	Microsoft определенное расширение OIDC для идентификации, позволяющее устранить проблемы с ресурсами без взаимодействия. Разрешает настройку одного или нескольких клиентских возможностей, например llt. (Унаследовано от AbstractApplicationBuilder<T>)
WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean, Boolean)	Устаревшие. Задает сертификат, связанный с приложением, вместе с конкретными утверждениями для подписывания. По умолчанию это приведет к слиянию claimsToSign требуемого набора утверждений по умолчанию, необходимых для проверки подлинности. Если mergeWithDefaultClaims задано значение false, необходимо указать необходимые утверждения по умолчанию. См. https://aka.ms/msal-net-client-assertion
WithClientClaims(X509Certificate2, IDictionary<String,String>, Boolean)	Устаревшие. Задает сертификат, связанный с приложением, вместе с конкретными утверждениями для подписывания. По умолчанию это приведет к слиянию claimsToSign требуемого набора утверждений по умолчанию, необходимых для проверки подлинности. Если mergeWithDefaultClaims задано значение false, необходимо указать необходимые утверждения по умолчанию. См. https://aka.ms/msal-net-client-assertion
WithClientId(String)	Задает идентификатор клиента приложения (Унаследовано от AbstractApplicationBuilder<T>)
WithClientName(String)	Задает имя вызывающего API ПАКЕТА SDK для целей телеметрии. (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithClientSecret(String)	Задает секрет приложения
WithClientVersion(String)	Задает версию вызывающего пакета SDK для целей телеметрии. (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithDebugLoggingCallback(LogLevel, Boolean, Boolean)	Задает обратный вызов журнала отладки методом отладки по умолчанию, который отображает уровень сообщения и самого сообщения. Дополнительные сведения см. в разделе https://aka.ms/msal-net-logging (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithExperimentalFeatures(Boolean)	Позволяет использовать экспериментальные функции и API. Если этот флаг не задан, экспериментальные функции будут вызывать исключение. Дополнительные сведения см. в разделе https://aka.ms/msal-net-experimental-features (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithExtraQueryParameters(IDictionary<String,String>)	Устаревшие. Задает дополнительные параметры запроса для строки запроса в http-запросе проверки подлинности (Унаследовано от AbstractApplicationBuilder<T>)
WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>)	Задает дополнительные параметры запроса для строки запроса в http-запросе проверки подлинности с помощью управления параметрами, включенными в ключ кэша. (Унаследовано от AbstractApplicationBuilder<T>)
WithExtraQueryParameters(String)	Устаревшие. Задает дополнительные параметры запроса для строки запроса в http-запросе проверки подлинности (Унаследовано от AbstractApplicationBuilder<T>)
WithGenericAuthority(String)	Устаревшие. Вместо него вызовите метод WithOidcAuthority(String).
WithHttpClientFactory(IMsalHttpClientFactory, Boolean)	Использует конкретный IMsalHttpClientFactory объект для взаимодействия с idP. Это позволяет выполнять расширенные сценарии, такие как установка прокси-сервера или настройка агента. (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithHttpClientFactory(IMsalHttpClientFactory)	Использует конкретный IMsalHttpClientFactory объект для взаимодействия с idP. Это позволяет выполнять расширенные сценарии, такие как установка прокси-сервера или настройка агента. (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithInstanceDicoveryMetadata(String)	Устаревшие. Позволяет разработчикам настраивать собственные допустимые органы. Необходимо указать строку JSON, аналогичную https://aka.ms/aad-instance-discovery этой строке. MSAL использует следующие сведения: Вызов REST API в среде, указанной в preferred_network Определение среды, в которой можно сохранить маркеры и учетные записи в кэше. Использование псевдонимов среды для сопоставления маркеров, выданных другим властям Дополнительные сведения см. в разделе https://aka.ms/msal-net-custom-instance-metadata (Унаследовано от AbstractApplicationBuilder<T>)
WithInstanceDicoveryMetadata(Uri)	Устаревшие. Позволяет организации настроить собственную службу для обработки обнаружения экземпляров, что позволяет лучше кэширование для микрослужб или сред службы. Uri, возвращающий ответ, аналогичный https://aka.ms/aad-instance-discovery указанному, должен быть предоставлен. MSAL использует следующие сведения: Вызов REST API в среде, указанной в preferred_network Определение среды, в которой можно сохранить маркеры и учетные записи в кэше. Использование псевдонимов среды для сопоставления маркеров, выданных другим властям Дополнительные сведения см. в разделе https://aka.ms/msal-net-custom-instance-metadata (Унаследовано от AbstractApplicationBuilder<T>)
WithInstanceDiscovery(Boolean)	Определяет, выполняется ли обнаружение экземпляров при попытке проверки подлинности. Если задано значение false, это полностью отключит обнаружение экземпляров и проверку центра. Это не повлияет на поведение приложения, настроенного с региональными конечными точками. (Унаследовано от AbstractApplicationBuilder<T>)
WithInstanceDiscoveryMetadata(String)	Позволяет разработчикам настраивать собственные допустимые органы. Необходимо указать строку JSON, аналогичную https://aka.ms/aad-instance-discovery этой строке. MSAL использует следующие сведения: Вызов REST API в среде, указанной в preferred_network Определение среды, в которой можно сохранить маркеры и учетные записи в кэше. Использование псевдонимов среды для сопоставления маркеров, выданных другим властям Дополнительные сведения см. в разделе https://aka.ms/msal-net-custom-instance-metadata (Унаследовано от AbstractApplicationBuilder<T>)
WithInstanceDiscoveryMetadata(Uri)	Позволяет организации настроить собственную службу для обработки обнаружения экземпляров, что позволяет лучше кэширование для микрослужб или сред службы. Uri, возвращающий ответ, аналогичный https://aka.ms/aad-instance-discovery указанному, должен быть предоставлен. MSAL использует следующие сведения: Вызов REST API в среде, указанной в preferred_network Определение среды, в которой можно сохранить маркеры и учетные записи в кэше. Использование псевдонимов среды для сопоставления маркеров, выданных другим властям Дополнительные сведения см. в разделе https://aka.ms/msal-net-custom-instance-metadata (Унаследовано от AbstractApplicationBuilder<T>)
WithLegacyCacheCompatibility(Boolean)	Включает сериализацию и десериализацию устаревшего кэша ADAL. (Унаследовано от AbstractApplicationBuilder<T>)
WithLogging(IIdentityLogger, Boolean)	Задает средство ведения журнала удостоверений. Дополнительные сведения см. в разделе https://aka.ms/msal-net-logging (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>)	Задает обратный вызов ведения журнала. Дополнительные сведения см. в разделе https://aka.ms/msal-net-logging (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithOidcAuthority(String)	Добавляет известный центр, соответствующий универсальному поставщику удостоверений OpenIdConnect. MSAL добавит .well-known/openid-configuration" в центр и извлекает метаданные OIDC из него, чтобы выяснить конечные точки. См. https://openid.net/specs/openid-connect-core-1_0.html#Terminology
WithOptions(ApplicationOptions)	Задает параметры приложения, которые, например, были прочитаны из файлов конфигурации. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от AbstractApplicationBuilder<T>)
WithOptions(BaseApplicationOptions)	Задает параметры приложения, которые, например, были прочитаны из файлов конфигурации. См. https://aka.ms/msal-net-application-configuration. (Унаследовано от BaseAbstractApplicationBuilder<T>)
WithRedirectUri(String)	Задает универсальный код ресурса (URI перенаправления) приложения. URI также должен быть зарегистрирован на портале приложения. См. https://aka.ms/msal-net-application-configuration (Унаследовано от AbstractApplicationBuilder<T>)
WithTelemetry(ITelemetryConfig)	Устаревшие. Создание событий агрегирования телеметрии. (Унаследовано от AbstractApplicationBuilder<T>)
WithTelemetryClient(ITelemetryClient[])	Устаревшие. Этот метод устарел. См. https://aka.ms/msal-net-telemetry
WithTenantId(String)	Задает идентификатор клиента организации, из которой приложение позволит пользователям входить. Это обычно GUID или доменное имя. См. https://aka.ms/msal-net-application-configuration. Хотя также можно задать tenantIdcommonзначение , organizationsи consumers, рекомендуется использовать одно из переопределения WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean). (Унаследовано от AbstractApplicationBuilder<T>)

Методы расширения

Имя	Описание
OnCompletion(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task>)	Настраивает асинхронный обратный вызов, который вызывается при завершении запроса на получение маркера. Этот обратный вызов вызывается один раз для каждого AcquireTokenForClient вызова, после того как все попытки повторных попыток были исчерпаны. В то время как именуется OnCompletion в общем случае, этот обратный вызов запускается как для успешных, так и неудачных приобретений. Это позволяет выполнять такие сценарии, как телеметрия, ведение журнала и настраиваемая обработка результатов.
OnMsalServiceFailure(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,ExecutionResult,Task<Boolean>>)	Настраивает асинхронный обратный вызов, который вызывается при получении MSAL ответа об ошибке от поставщика удостоверений (служба маркеров безопасности). Обратный вызов определяет, следует ли MSAL повторить запрос маркера или распространить исключение. Этот обратный вызов вызывается после каждого сбоя службы и может вызываться несколько раз до тех пор, пока он не вернет false или запрос завершится успешно.
WithAppTokenProvider(ConfidentialClientApplicationBuilder, Func<AppTokenProviderParameters,Task<AppTokenProviderResult>>)	Позволяет задать обратный вызов, который возвращает маркер доступа на основе переданных параметров. MSAL передает параметры проверки подлинности обратному вызову, и ожидается, что обратный вызов будет создавать AppTokenProviderResult и возвращать его в MSAL. MSAL кэширует ответ маркера так же, как и для других результатов проверки подлинности.
WithCertificate(ConfidentialClientApplicationBuilder, Func<AssertionRequestOptions,Task<X509Certificate2>>, CertificateOptions)	Настраивает асинхронный обратный вызов для динамического предоставления сертификата учетных данных клиента. Обратный вызов вызывается перед каждым запросом на получение маркера поставщику удостоверений (включая повторные попытки). Это позволяет выполнять такие сценарии, как смена сертификатов и динамический выбор сертификатов на основе контекста приложения.
WithCertificate(ConfidentialClientApplicationBuilder, X509Certificate2, Boolean, Boolean)	Задает сертификат, связанный с приложением. Применимо только к приложениям первой стороны, этот метод также позволяет указать, следует ли отправлять утверждение x5c в Azure AD. Отправка x5c позволяет разработчикам приложений выполнять простой перекат сертификатов в Azure AD: этот метод отправляет цепочку сертификатов в Azure AD вместе с запросом маркера, чтобы Azure AD мог использовать его для проверки имени субъекта на основе политики доверенного издателя. Это сохраняет администратора приложения от необходимости явно управлять переключением сертификата (с помощью портала или операции PowerShell/CLI). Дополнительные сведения см. в этом https://aka.ms/msal-net-sni API, чтобы связать маркеры, полученные из Azure AD, с серийным номером сертификата. Это можно использовать для секционирования кэша по сертификату. Маркеры, приобретенные с одним сертификатом, не будут доступны другому сертификату с другим серийным номером.