InteractiveCredentialOptions interface
需要用户交互的标识凭据的常见构造函数选项。
属性
authentication |
以前可用于检索每个帐户的缓存凭据的身份验证的结果。 如果应用程序想要使用每个客户端 ID 和租户 ID 对的多个帐户,则需要提供这一点。 可以通过调用凭据的
|
disable |
如果需要手动身份验证,则使 getToken 引发。
开发人员需要调用 |
继承属性
additionally |
对于多租户应用程序,指定凭据可以获取令牌的其他租户。 添加通配符值“*”,以允许凭据获取安装应用程序的任何租户的令牌。 |
additional |
要包含在 HTTP 管道中的其他策略。 |
agent | 为传出请求配置代理实例的选项 |
allow |
如果请求通过 HTTP 而不是 HTTPS 发送,则设置为 true |
authority |
用于身份验证请求的颁发机构主机。
可以通过 azureAuthorityHosts |
disable |
该字段确定在尝试进行身份验证时是否执行实例发现。
将此项设置为 |
http |
将用于发送 HTTP 请求的 HttpClient。 |
logging |
允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。 |
proxy |
为传出请求配置代理的选项。 |
redirect |
有关如何处理重定向响应的选项。 |
retry |
控制如何重试失败请求的选项。 |
telemetry |
用于将常见遥测和跟踪信息设置为传出请求的选项。 |
tls |
配置 TLS 身份验证的选项 |
user |
用于将用户代理详细信息添加到传出请求的选项。 |
属性详细信息
authenticationRecord
以前可用于检索每个帐户的缓存凭据的身份验证的结果。 如果应用程序想要使用每个客户端 ID 和租户 ID 对的多个帐户,则需要提供这一点。
可以通过调用凭据的 authenticate()
方法来检索此记录,如下所示:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
属性值
disableAutomaticAuthentication
如果需要手动身份验证,则使 getToken 引发。
开发人员需要调用 authenticate()
来控制何时手动进行身份验证。
disableAutomaticAuthentication?: boolean
属性值
boolean
继承属性详细信息
additionallyAllowedTenants
对于多租户应用程序,指定凭据可以获取令牌的其他租户。 添加通配符值“*”,以允许凭据获取安装应用程序的任何租户的令牌。
additionallyAllowedTenants?: string[]
属性值
string[]
继承自MultiTenantTokenCredentialOptions.additionallyAllowedTenants
additionalPolicies
要包含在 HTTP 管道中的其他策略。
additionalPolicies?: AdditionalPolicyConfig[]
属性值
agent
allowInsecureConnection
如果请求通过 HTTP 而不是 HTTPS 发送,则设置为 true
allowInsecureConnection?: boolean
属性值
boolean
继承自MultiTenantTokenCredentialOptions.allowInsecureConnection
authorityHost
用于身份验证请求的颁发机构主机。
可以通过 azureAuthorityHosts
authorityHost?: string
属性值
string
disableInstanceDiscovery
该字段确定在尝试进行身份验证时是否执行实例发现。
将此项设置为 true
将完全禁用实例发现和颁发机构验证。
因此,确保配置的颁发机构主机有效且可信至关重要。
此功能适用于无法访问元数据终结点的情况,例如在私有云或 Azure Stack 中。
实例发现过程需要从 https://login.microsoft.com/ 中检索颁发机构元数据来验证颁发机构。
disableInstanceDiscovery?: boolean
属性值
boolean
httpClient
将用于发送 HTTP 请求的 HttpClient。
httpClient?: HttpClient
属性值
loggingOptions
允许用户配置日志记录策略选项的设置、允许日志记录帐户信息和客户支持的个人身份信息。
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
属性值
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
proxyOptions
为传出请求配置代理的选项。
proxyOptions?: ProxySettings
属性值
redirectOptions
有关如何处理重定向响应的选项。
redirectOptions?: RedirectPolicyOptions
属性值
retryOptions
控制如何重试失败请求的选项。
retryOptions?: PipelineRetryOptions
属性值
telemetryOptions
用于将常见遥测和跟踪信息设置为传出请求的选项。
telemetryOptions?: TelemetryOptions
属性值
tlsOptions
配置 TLS 身份验证的选项
tlsOptions?: TlsSettings
属性值
userAgentOptions
用于将用户代理详细信息添加到传出请求的选项。
userAgentOptions?: UserAgentPolicyOptions