通过

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

InteractiveBrowserCredentialNodeOptions interface

  • 参考
包:
@azure/identity

定义 InteractiveBrowserCredential 类的常用选项。

扩展

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

属性

clientId

用户将登录的 Microsoft Entra 应用程序的客户端 ID。 建议开发人员注册其应用程序并分配适当的角色。 有关详细信息，请访问 https://aka.ms/identity/AppRegistrationAndRoleAssignment。 如果未指定，则用户将对 Azure 开发应用程序进行身份验证，不建议在生产方案中使用。
loginHint

loginHint 允许为交互式登录预先选择用户名。 设置此选项会跳过帐户选择提示，并立即尝试使用指定的帐户登录。
redirectUri

获取应用程序的重定向 URI。 这应与应用程序注册门户中的值相同。 默认为 window.location.href。 Node.js不再需要此字段。
tenantId

Microsoft Entra 租户（目录）ID。

继承属性

additionallyAllowedTenants

对于多租户应用程序，指定凭据可以获取令牌的其他租户。 添加通配符值“*”，以允许凭据获取安装应用程序的任何租户的令牌。
additionalPolicies

要包含在 HTTP 管道中的其他策略。
allowInsecureConnection

如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true
authenticationRecord

以前可用于检索每个帐户的缓存凭据的身份验证的结果。 如果应用程序想要使用每个客户端 ID 和租户 ID 对的多个帐户，则需要提供这一点。

可以通过调用凭据的 authenticate() 方法来检索此记录，如下所示：

const authenticationRecord = await credential.authenticate();
authorityHost

用于身份验证请求的颁发机构主机。 可以通过 azureAuthorityHosts获取可能的值。 默认值为“https://login.microsoftonline.com"。
brokerOptions

使用 InteractiveBrowserCredential 时允许中转站身份验证的选项
browserCustomizationOptions

用于浏览器自定义的共享配置选项
disableAutomaticAuthentication

如果需要手动身份验证，则使 getToken 引发。 开发人员需要调用 authenticate() 来控制何时手动进行身份验证。
disableInstanceDiscovery

该字段确定在尝试进行身份验证时是否执行实例发现。 将此项设置为 true 将完全禁用实例发现和颁发机构验证。 因此，确保配置的颁发机构主机有效且可信至关重要。 此功能适用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 检索颁发机构元数据来验证颁发机构。
httpClient

将用于发送 HTTP 请求的 HttpClient。
loggingOptions

允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。
proxyOptions

为传出请求配置代理的选项。
redirectOptions

有关如何处理重定向响应的选项。
retryOptions

控制如何重试失败请求的选项。
telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。
tlsOptions

配置 TLS 身份验证的选项
tokenCachePersistenceOptions

存储凭据时提供给持久性层的选项（如果有）。

必须首先注册持久性提供程序插件。 请参阅 NPM 上的 @azure/identity-cache-persistence 包。

例：

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});
userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

属性详细信息

clientId

用户将登录的 Microsoft Entra 应用程序的客户端 ID。 建议开发人员注册其应用程序并分配适当的角色。 有关详细信息，请访问 https://aka.ms/identity/AppRegistrationAndRoleAssignment。 如果未指定，则用户将对 Azure 开发应用程序进行身份验证，不建议在生产方案中使用。

clientId?: string

属性值

string

loginHint

loginHint 允许为交互式登录预先选择用户名。 设置此选项会跳过帐户选择提示，并立即尝试使用指定的帐户登录。

loginHint?: string

属性值

string

redirectUri

获取应用程序的重定向 URI。 这应与应用程序注册门户中的值相同。 默认为 window.location.href。 Node.js不再需要此字段。

redirectUri?: string | () => string

属性值

string | () => string

tenantId

Microsoft Entra 租户（目录）ID。

tenantId?: string

属性值

string

继承属性详细信息

additionallyAllowedTenants

对于多租户应用程序，指定凭据可以获取令牌的其他租户。 添加通配符值“*”，以允许凭据获取安装应用程序的任何租户的令牌。

additionallyAllowedTenants?: string[]

属性值

string[]

继承自InteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

要包含在 HTTP 管道中的其他策略。

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自InteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true

allowInsecureConnection?: boolean

属性值

boolean

继承自InteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

以前可用于检索每个帐户的缓存凭据的身份验证的结果。 如果应用程序想要使用每个客户端 ID 和租户 ID 对的多个帐户，则需要提供这一点。

可以通过调用凭据的 authenticate() 方法来检索此记录，如下所示：

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

属性值

AuthenticationRecord

继承自InteractiveCredentialOptions.authenticationRecord

authorityHost

用于身份验证请求的颁发机构主机。 可以通过 azureAuthorityHosts获取可能的值。 默认值为“https://login.microsoftonline.com"。

authorityHost?: string

属性值

string

继承自InteractiveCredentialOptions.authorityHost

brokerOptions

使用 InteractiveBrowserCredential 时允许中转站身份验证的选项

brokerOptions?: BrokerOptions

属性值

BrokerOptions

继承自BrokerAuthOptions.brokerOptions

browserCustomizationOptions

用于浏览器自定义的共享配置选项

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

属性值

{ errorMessage?: string, successMessage?: string }

继承自BrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

如果需要手动身份验证，则使 getToken 引发。 开发人员需要调用 authenticate() 来控制何时手动进行身份验证。

disableAutomaticAuthentication?: boolean

属性值

boolean

继承自InteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

该字段确定在尝试进行身份验证时是否执行实例发现。 将此项设置为 true 将完全禁用实例发现和颁发机构验证。 因此，确保配置的颁发机构主机有效且可信至关重要。 此功能适用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。 实例发现过程需要从 https://login.microsoft.com/ 检索颁发机构元数据来验证颁发机构。

disableInstanceDiscovery?: boolean

属性值

boolean

继承自InteractiveCredentialOptions.disableInstanceDiscovery

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自InteractiveCredentialOptions.httpClient

loggingOptions

允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

属性值

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

继承自InteractiveCredentialOptions.loggingOptions

proxyOptions

为传出请求配置代理的选项。

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自InteractiveCredentialOptions.proxyOptions

redirectOptions

有关如何处理重定向响应的选项。

redirectOptions?: RedirectPolicyOptions

属性值

RedirectPolicyOptions

继承自InteractiveCredentialOptions.redirectOptions

retryOptions

控制如何重试失败请求的选项。

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自InteractiveCredentialOptions.retryOptions

telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自InteractiveCredentialOptions.telemetryOptions

tlsOptions

配置 TLS 身份验证的选项

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自InteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

存储凭据时提供给持久性层的选项（如果有）。

必须首先注册持久性提供程序插件。 请参阅 NPM 上的 @azure/identity-cache-persistence 包。

例：

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

属性值

TokenCachePersistenceOptions

继承自CredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自InteractiveCredentialOptions.userAgentOptions