HostnameConfiguration | @azure/arm-apimanagement

Custom hostname configuration.

Hierarchy

HostnameConfiguration

Index

Properties

Optional certificate

certificate: CertificateInformation

Certificate information.

Optional certificatePassword

certificatePassword: undefined | string

Certificate Password.

Optional certificateSource

certificateSource: CertificateSource

Certificate Source.

Optional certificateStatus

certificateStatus: CertificateStatus

Certificate Status.

Optional defaultSslBinding

defaultSslBinding: undefined | false | true

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 Proxy Hostname Type.

Optional encodedCertificate

encodedCertificate: undefined | string

Base64 Encoded certificate.

hostName

hostName: string

Hostname to configure on the Api Management service.

Optional identityClientId

identityClientId: undefined | string

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

Optional keyVaultId

keyVaultId: undefined | string

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

Optional negotiateClientCertificate

negotiateClientCertificate: undefined | false | true

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

type

type: HostnameType

Hostname type.