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

DeviceCodeCredentialOptions 类

定义

命名空间:

Azure.Identity

程序集:

Azure.Identity.dll

包:

Azure.Identity v1.11.3

Source:

DeviceCodeCredentialOptions.cs

用于配置 的选项 DeviceCodeCredential。

public class DeviceCodeCredentialOptions : Azure.Identity.TokenCredentialOptions

type DeviceCodeCredentialOptions = class
    inherit TokenCredentialOptions

Public Class DeviceCodeCredentialOptions
Inherits TokenCredentialOptions

继承

Object

ClientOptions

TokenCredentialOptions

DeviceCodeCredentialOptions

构造函数

DeviceCodeCredentialOptions()

用于配置 的选项 DeviceCodeCredential。

属性

AdditionallyAllowedTenants	除了指定凭据可能为其获取令牌的 指定 TenantId 之外，还指定租户。 添加通配符值“*”，以允许凭据为登录帐户可以访问的任何租户获取令牌。 如果未为 TenantId指定值，此选项将不起作用，并且凭据将获取任何请求的租户的令牌。
AuthenticationRecord	AuthenticationRecord从以前的身份验证中捕获的 。
AuthorityHost	Microsoft Entra颁发机构的主机。 默认为 https://login.microsoftonline.com/。 有关 Azure 云实例的已知颁发机构主机，请参阅 AzureAuthorityHosts。 (继承自 TokenCredentialOptions)
ClientId	用于对用户进行身份验证的应用程序的客户端 ID。 如果未指定，将使用 Azure 开发应用程序对用户进行身份验证。
DeviceCodeCallback	将执行的回调，向用户显示设备代码登录详细信息。 在 未指定 中，设备代码和登录说明将输出到控制台。
Diagnostics	获取凭据诊断选项。 (继承自 TokenCredentialOptions)
DisableAutomaticAuthentication	阻止 DeviceCodeCredential 自动提示用户。 如果禁用了自动身份验证，则在需要用户交互的情况下，将从 和 GetTokenAsync(TokenRequestContext, CancellationToken) 引发 GetToken(TokenRequestContext, CancellationToken) AuthenticationRequiredException。 应用程序负责处理此异常，并调用 Authenticate(CancellationToken) 或 AuthenticateAsync(CancellationToken) 以交互方式对用户进行身份验证。
DisableInstanceDiscovery	获取或设置设置，该设置确定在尝试进行身份验证时是否执行实例发现。 将其设置为 true 将完全禁用实例发现和颁发机构验证。 此功能适用于无法访问元数据终结点的方案，例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据以验证颁发机构。 通过将此项设置为 true，将禁用对颁发机构的验证。 因此，确保配置的颁发机构主机有效且可信至关重要。”
IsUnsafeSupportLoggingEnabled	获取或设置值，该值指示是否应记录包含潜在敏感内容的 ETW 日志记录。 将此属性设置为 true 不会禁用内容编 Request 修。 若要启用敏感 Content 日志记录， IsLoggingContentEnabled 必须将 属性设置为 true。 将此属性设置为 true 等同于将 enablePiiLogging 参数的“true”传递给 MSAL 客户端生成器上的“WithLogging”方法。 (继承自 TokenCredentialOptions)
Retry	获取客户端重试选项。 (继承自 ClientOptions)
RetryPolicy	获取或设置用于重试的策略。 如果指定了策略，则将使用该策略来代替 Retry 属性。 RetryPolicy可以从 派生类型来修改默认行为，而无需完全实现重试逻辑。 如果 Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) 重写或指定了自定义 HttpPipelinePolicy ，则实施者负责更新 ProcessingContext 值。 (继承自 ClientOptions)
TenantId	用户将进行身份验证的租户 ID。 如果未指定，用户将向其主租户进行身份验证。
TokenCachePersistenceOptions	指定要 TokenCachePersistenceOptions 由凭据使用的 。 如果未指定选项，令牌缓存将不会保存到磁盘。
Transport	HttpPipelineTransport要用于此客户端的 。 默认为 的 HttpClientTransport实例。 (继承自 ClientOptions)

方法

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

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