HostnameConfiguration Class

Package:

com.microsoft.azure.management.apimanagement.v2019_01_01

Maven Artifact:

com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

• java.lang.Object
• • com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration

public class HostnameConfiguration

Custom hostname configuration.

Constructor Summary

Constructor	Description
HostnameConfiguration()

Method Summary

Modifier and Type	Method and Description
CertificateInformation	certificate() Get certificate information.
java.lang.String	certificatePassword() Get certificate Password.
java.lang.Boolean	defaultSslBinding() Get specify true to setup the certificate associated with this Hostname as the Default SSL Certificate.
java.lang.String	encodedCertificate() Get base64 Encoded certificate.
java.lang.String	hostName() Get hostname to configure on the Api Management service.
java.lang.String	keyVaultId() Get url to the KeyVault Secret containing the Ssl Certificate.
java.lang.Boolean	negotiateClientCertificate() Get specify true to always negotiate client certificate on the hostname.
HostnameType	type() Get hostname type.
HostnameConfiguration	withCertificate(CertificateInformation certificate) Set certificate information.
HostnameConfiguration	withCertificatePassword(String certificatePassword) Set certificate Password.
HostnameConfiguration	withDefaultSslBinding(Boolean defaultSslBinding) Set specify true to setup the certificate associated with this Hostname as the Default SSL Certificate.
HostnameConfiguration	withEncodedCertificate(String encodedCertificate) Set base64 Encoded certificate.
HostnameConfiguration	withHostName(String hostName) Set hostname to configure on the Api Management service.
HostnameConfiguration	withKeyVaultId(String keyVaultId) Set url to the KeyVault Secret containing the Ssl Certificate.
HostnameConfiguration	withNegotiateClientCertificate(Boolean negotiateClientCertificate) Set specify true to always negotiate client certificate on the hostname.
HostnameConfiguration	withType(HostnameType type) Set hostname type.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

HostnameConfiguration

public HostnameConfiguration()

Method Details

certificate

public CertificateInformation certificate()

Get certificate information.

Returns:

the certificate value

certificatePassword

public String certificatePassword()

Get certificate Password.

Returns:

the certificatePassword value

defaultSslBinding

public Boolean defaultSslBinding()

Get 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.

Returns:

the defaultSslBinding value

encodedCertificate

public String encodedCertificate()

Get base64 Encoded certificate.

Returns:

the encodedCertificate value

hostName

public String hostName()

Get hostname to configure on the Api Management service.

Returns:

the hostName value

keyVaultId

public String keyVaultId()

Get 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 MSI. The secret should be of type *application/x-pkcs12*.

Returns:

the keyVaultId value

negotiateClientCertificate

public Boolean negotiateClientCertificate()

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

Returns:

the negotiateClientCertificate value

type

public HostnameType type()

Get hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'.

Returns:

the type value

withCertificate

public HostnameConfiguration withCertificate(CertificateInformation certificate)

Set certificate information.

Parameters:

certificate - the certificate value to set

Returns:

the HostnameConfiguration object itself.

withCertificatePassword

public HostnameConfiguration withCertificatePassword(String certificatePassword)

Set certificate Password.

Parameters:

certificatePassword - the certificatePassword value to set

Returns:

the HostnameConfiguration object itself.

withDefaultSslBinding

public HostnameConfiguration withDefaultSslBinding(Boolean defaultSslBinding)

Set 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.

Parameters:

defaultSslBinding - the defaultSslBinding value to set

Returns:

the HostnameConfiguration object itself.

withEncodedCertificate

public HostnameConfiguration withEncodedCertificate(String encodedCertificate)

Set base64 Encoded certificate.

Parameters:

encodedCertificate - the encodedCertificate value to set

Returns:

the HostnameConfiguration object itself.

withHostName

public HostnameConfiguration withHostName(String hostName)

Set hostname to configure on the Api Management service.

Parameters:

hostName - the hostName value to set

Returns:

the HostnameConfiguration object itself.

withKeyVaultId

public HostnameConfiguration withKeyVaultId(String keyVaultId)

Set 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 MSI. The secret should be of type *application/x-pkcs12*.

Parameters:

keyVaultId - the keyVaultId value to set

Returns:

the HostnameConfiguration object itself.

withNegotiateClientCertificate

public HostnameConfiguration withNegotiateClientCertificate(Boolean negotiateClientCertificate)

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

Parameters:

negotiateClientCertificate - the negotiateClientCertificate value to set

Returns:

the HostnameConfiguration object itself.

withType

public HostnameConfiguration withType(HostnameType type)

Set hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'.

Parameters:

type - the type value to set

Returns:

the HostnameConfiguration object itself.