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

HostnameConfiguration interface

包:

@azure/arm-apimanagement

自定义主机名配置。

属性

certificate	证书信息。
certificatePassword	证书密码。
certificateSource	证书源。
certificateStatus	证书状态。
defaultSslBinding	指定 true 以设置与此主机名关联的证书作为默认 SSL 证书。 如果客户端未发送 SNI 标头，则这是将质询的证书。 如果某个服务启用了多个自定义主机名，并且需要确定默认 ssl 证书，则此属性非常有用。 此设置仅适用于网关主机名类型。
encodedCertificate	Base64 编码证书。
hostName	在 Api 管理服务上配置的主机名。
identityClientId	Azure AD 生成的系统或用户分配的托管标识 clientId，该客户端有权访问包含 SSL 证书的 keyVault。
keyVaultId	包含 Ssl 证书的 KeyVault 机密的 URL。 如果提供了包含版本的绝对 URL，则 ssl 证书的自动更新将不起作用。 这要求使用 aka.ms/apimmsi 配置 Api 管理服务。 机密的类型应 为 application/x-pkcs12
negotiateClientCertificate	指定 true 以始终协商主机名上的客户端证书。 默认值为 false。
type	主机名类型。

属性详细信息

certificate

证书信息。

certificate?: CertificateInformation

属性值

CertificateInformation

certificatePassword

证书密码。

certificatePassword?: string

属性值

string

certificateSource

证书源。

certificateSource?: string

属性值

string

certificateStatus

证书状态。

certificateStatus?: string

属性值

string

defaultSslBinding

指定 true 以设置与此主机名关联的证书作为默认 SSL 证书。 如果客户端未发送 SNI 标头，则这是将质询的证书。 如果某个服务启用了多个自定义主机名，并且需要确定默认 ssl 证书，则此属性非常有用。 此设置仅适用于网关主机名类型。

defaultSslBinding?: boolean

属性值

boolean

encodedCertificate

Base64 编码证书。

encodedCertificate?: string

属性值

string

hostName

在 Api 管理服务上配置的主机名。

hostName: string

属性值

string

identityClientId

Azure AD 生成的系统或用户分配的托管标识 clientId，该客户端有权访问包含 SSL 证书的 keyVault。

identityClientId?: string

属性值

string

keyVaultId

包含 Ssl 证书的 KeyVault 机密的 URL。 如果提供了包含版本的绝对 URL，则 ssl 证书的自动更新将不起作用。 这要求使用 aka.ms/apimmsi 配置 Api 管理服务。 机密的类型应 为 application/x-pkcs12

keyVaultId?: string

属性值

string

negotiateClientCertificate

指定 true 以始终协商主机名上的客户端证书。 默认值为 false。

negotiateClientCertificate?: boolean

属性值

boolean

type

主机名类型。

type: string

属性值

string