使用英语阅读

通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

DefaultAzureCredentialOptions 类

定义

用于配置 DefaultAzureCredential 身份验证流和向 Azure 标识服务发出的请求的选项。

public class DefaultAzureCredentialOptions : Azure.Identity.TokenCredentialOptions
继承
DefaultAzureCredentialOptions

构造函数

DefaultAzureCredentialOptions()

用于配置 DefaultAzureCredential 身份验证流和向 Azure 标识服务发出的请求的选项。

属性

AdditionallyAllowedTenants

除了指定凭据可能为其获取令牌的 指定 TenantId 之外,还指定租户。 添加通配符值“*”,以允许凭据为登录帐户可以访问的任何租户获取令牌。 如果未为 TenantId指定值,则此选项不会影响该身份验证方法,并且凭据将在使用该方法时获取任何请求的租户的令牌。 也可以通过将环境变量设置为AZURE_ADDITIONALLY_ALLOWED_TENANTS来设置此值。

AuthorityHost

Microsoft Entra颁发机构的主机。 默认为 https://login.microsoftonline.com/。 有关 Azure 云实例的已知颁发机构主机,请参阅 AzureAuthorityHosts

(继承自 TokenCredentialOptions)
CredentialProcessTimeout

指定通过子进程调用的凭据的超时。 例如 Visual Studio、Azure CLI、Azure Powershell。

Diagnostics

获取凭据诊断选项。

(继承自 TokenCredentialOptions)
DisableInstanceDiscovery

用于配置 DefaultAzureCredential 身份验证流和向 Azure 标识服务发出的请求的选项。

ExcludeAzureCliCredential

指定是否 AzureCliCredential 将从身份验证流中 DefaultAzureCredential 排除 。

ExcludeAzureDeveloperCliCredential

指定是否 AzureDeveloperCliCredential 将从身份验证流中 DefaultAzureCredential 排除 。

ExcludeAzurePowerShellCredential

指定是否 AzurePowerShellCredential 将从身份验证流中 DefaultAzureCredential 排除 。

ExcludeEnvironmentCredential

指定是否 EnvironmentCredential 将从身份验证流中排除 。 将 设置为 true 会禁用从进程的环境变量中读取身份验证详细信息。

ExcludeInteractiveBrowserCredential

指定是否 InteractiveBrowserCredential 将从身份验证流中 DefaultAzureCredential 排除 。 将 设置为 true 会禁用启动默认系统浏览器以在开发环境中进行身份验证。 默认为 true

ExcludeManagedIdentityCredential

指定是否 ManagedIdentityCredential 将从身份验证流中 DefaultAzureCredential 排除 。 设置为 true 会禁用对托管标识终结点进行身份验证。

ExcludeSharedTokenCacheCredential

指定是否 SharedTokenCacheCredential 将从身份验证流中 DefaultAzureCredential 排除 。 将 设置为 true 会禁用使用写入共享令牌缓存的开发工具进行单一登录身份验证。 默认为 true

ExcludeVisualStudioCodeCredential

指定是否 VisualStudioCodeCredential 将从身份验证流中 DefaultAzureCredential 排除 。 默认为 true

ExcludeVisualStudioCredential

指定是否 VisualStudioCredential 将从身份验证流中 DefaultAzureCredential 排除 。

ExcludeWorkloadIdentityCredential

指定是否 WorkloadIdentityCredential 将从身份验证流中排除 。 将 设置为 true 会禁用从进程的环境变量中读取身份验证详细信息。

InteractiveBrowserCredentialClientId

指定所选凭据的客户端 ID

IsUnsafeSupportLoggingEnabled

获取或设置值,该值指示是否应记录包含潜在敏感内容的 ETW 日志记录。 将此属性设置为 true 不会禁用内容编 Request 修。 若要启用敏感 Content 日志记录, IsLoggingContentEnabled 必须将 属性设置为 true。 将此属性设置为 true 等同于将 enablePiiLogging 参数的“true”传递给 MSAL 客户端生成器上的“WithLogging”方法。

(继承自 TokenCredentialOptions)
ManagedIdentityClientId

指定用户分配的 ManagedIdentity 的客户端 ID。 如果配置了此值,则 ManagedIdentityResourceId 不应配置此值。

ManagedIdentityResourceId

指定用户分配的 ManagedIdentity 的资源 ID。 如果配置了此值,则 ManagedIdentityClientId 不应配置此值。

Retry

获取客户端重试选项。

(继承自 ClientOptions)
RetryPolicy

获取或设置用于重试的策略。 如果指定了策略,则将使用该策略来代替 Retry 属性。 RetryPolicy可以从 派生类型来修改默认行为,而无需完全实现重试逻辑。 如果 Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) 重写或指定了自定义 HttpPipelinePolicy ,则实施者负责更新 ProcessingContext 值。

(继承自 ClientOptions)
SharedTokenCacheUsername

指定要从共享令牌缓存中检索的首选身份验证帐户,以便使用开发工具进行单一登录身份验证。 在共享令牌中找到多个帐户的情况下。

TenantId

默认情况下,凭据将向其进行身份验证的租户的 ID。 如果未指定,则凭据将向任何请求的租户进行身份验证,并默认为最初对所选身份验证方法进行身份验证的租户。

Transport

HttpPipelineTransport要用于此客户端的 。 默认为 的 HttpClientTransport实例。

(继承自 ClientOptions)
WorkloadIdentityClientId

指定工作负荷标识将进行身份验证的应用程序的客户端 ID。

方法

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

HttpPipeline 策略添加到客户端管道中。 策略在管道中的位置由 position 参数控制。 如果希望每个客户端请求执行一次策略,请使用 PerCall ,否则使用 PerRetry 在每次重试时运行策略。 请注意, 的 policy 同一实例将添加到使用此 ClientOptions 对象构造的客户端的所有管道中。

(继承自 ClientOptions)

适用于