Share via

HostnameConfiguration interface

  • Reference
Package:
@azure/arm-apimanagement

Custom hostname configuration.

Properties

certificate

Certificate information.
certificatePassword

Certificate Password.
certificateSource

Certificate Source.
certificateStatus

Certificate Status.
defaultSslBinding

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
encodedCertificate

Base64 Encoded certificate.
hostName

Hostname to configure on the Api Management service.
identityClientId

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
keyVaultId

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
negotiateClientCertificate

Specify true to always negotiate client certificate on the hostname. Default Value is false.
type

Hostname type.

Property Details

certificate

Certificate information.

certificate?: CertificateInformation

Property Value

CertificateInformation

certificatePassword

Certificate Password.

certificatePassword?: string

Property Value

string

certificateSource

Certificate Source.

certificateSource?: string

Property Value

string

certificateStatus

Certificate Status.

certificateStatus?: string

Property Value

string

defaultSslBinding

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.

defaultSslBinding?: boolean

Property Value

boolean

encodedCertificate

Base64 Encoded certificate.

encodedCertificate?: string

Property Value

string

hostName

Hostname to configure on the Api Management service.

hostName: string

Property Value

string

identityClientId

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

identityClientId?: string

Property Value

string

keyVaultId

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

keyVaultId?: string

Property Value

string

negotiateClientCertificate

Specify true to always negotiate client certificate on the hostname. Default Value is false.

negotiateClientCertificate?: boolean

Property Value

boolean

type

Hostname type.

type: string

Property Value

string