HostnameConfiguration Class

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.models.HostnameConfiguration

public final class HostnameConfiguration

Custom hostname configuration.

Constructor Summary

Constructor	Description
HostnameConfiguration()	Creates an instance of HostnameConfiguration class.

Method Summary

Modifier and Type	Method and Description
CertificateInformation	certificate() Get the certificate property: Certificate information.
String	certificatePassword() Get the certificatePassword property: Certificate Password.
CertificateSource	certificateSource() Get the certificateSource property: Certificate Source.
CertificateStatus	certificateStatus() Get the certificateStatus property: Certificate Status.
Boolean	defaultSslBinding() Get the defaultSslBinding property: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate.
String	encodedCertificate() Get the encodedCertificate property: Base64 Encoded certificate.
String	hostname() Get the hostname property: Hostname to configure on the Api Management service.
String	identityClientId() Get the identityClientId property: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
String	keyVaultId() Get the keyVaultId property: Url to the KeyVault Secret containing the Ssl Certificate.
Boolean	negotiateClientCertificate() Get the negotiateClientCertificate property: Specify true to always negotiate client certificate on the hostname.
HostnameType	type() Get the type property: Hostname type.
void	validate() Validates the instance.
HostnameConfiguration	withCertificate(CertificateInformation certificate) Set the certificate property: Certificate information.
HostnameConfiguration	withCertificatePassword(String certificatePassword) Set the certificatePassword property: Certificate Password.
HostnameConfiguration	withCertificateSource(CertificateSource certificateSource) Set the certificateSource property: Certificate Source.
HostnameConfiguration	withCertificateStatus(CertificateStatus certificateStatus) Set the certificateStatus property: Certificate Status.
HostnameConfiguration	withDefaultSslBinding(Boolean defaultSslBinding) Set the defaultSslBinding property: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate.
HostnameConfiguration	withEncodedCertificate(String encodedCertificate) Set the encodedCertificate property: Base64 Encoded certificate.
HostnameConfiguration	withHostname(String hostname) Set the hostname property: Hostname to configure on the Api Management service.
HostnameConfiguration	withIdentityClientId(String identityClientId) Set the identityClientId property: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
HostnameConfiguration	withKeyVaultId(String keyVaultId) Set the keyVaultId property: Url to the KeyVault Secret containing the Ssl Certificate.
HostnameConfiguration	withNegotiateClientCertificate(Boolean negotiateClientCertificate) Set the negotiateClientCertificate property: Specify true to always negotiate client certificate on the hostname.
HostnameConfiguration	withType(HostnameType type) Set the type property: Hostname type.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HostnameConfiguration

public HostnameConfiguration()

Creates an instance of HostnameConfiguration class.

Method Details

certificate

public CertificateInformation certificate()

Get the certificate property: Certificate information.

Returns:

the certificate value.

certificatePassword

public String certificatePassword()

Get the certificatePassword property: Certificate Password.

Returns:

the certificatePassword value.

certificateSource

public CertificateSource certificateSource()

Get the certificateSource property: Certificate Source.

Returns:

the certificateSource value.

certificateStatus

public CertificateStatus certificateStatus()

Get the certificateStatus property: Certificate Status.

Returns:

the certificateStatus value.

defaultSslBinding

public Boolean defaultSslBinding()

Get the defaultSslBinding property: 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.

Returns:

the defaultSslBinding value.

encodedCertificate

public String encodedCertificate()

Get the encodedCertificate property: Base64 Encoded certificate.

Returns:

the encodedCertificate value.

hostname

public String hostname()

Get the hostname property: Hostname to configure on the Api Management service.

Returns:

the hostname value.

identityClientId

public String identityClientId()

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

Returns:

the identityClientId value.

keyVaultId

public String keyVaultId()

Get the keyVaultId property: 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*.

Returns:

the keyVaultId value.

negotiateClientCertificate

public Boolean negotiateClientCertificate()

Get the negotiateClientCertificate property: Specify true to always negotiate client certificate on the hostname. Default Value is false.

Returns:

the negotiateClientCertificate value.

type

public HostnameType type()

Get the type property: Hostname type.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withCertificate

public HostnameConfiguration withCertificate(CertificateInformation certificate)

Set the certificate property: Certificate information.

Parameters:

certificate - the certificate value to set.

Returns:

the HostnameConfiguration object itself.

withCertificatePassword

public HostnameConfiguration withCertificatePassword(String certificatePassword)

Set the certificatePassword property: Certificate Password.

Parameters:

certificatePassword - the certificatePassword value to set.

Returns:

the HostnameConfiguration object itself.

withCertificateSource

public HostnameConfiguration withCertificateSource(CertificateSource certificateSource)

Set the certificateSource property: Certificate Source.

Parameters:

certificateSource - the certificateSource value to set.

Returns:

the HostnameConfiguration object itself.

withCertificateStatus

public HostnameConfiguration withCertificateStatus(CertificateStatus certificateStatus)

Set the certificateStatus property: Certificate Status.

Parameters:

certificateStatus - the certificateStatus value to set.

Returns:

the HostnameConfiguration object itself.

withDefaultSslBinding

public HostnameConfiguration withDefaultSslBinding(Boolean defaultSslBinding)

Set the defaultSslBinding property: 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.

Parameters:

defaultSslBinding - the defaultSslBinding value to set.

Returns:

the HostnameConfiguration object itself.

withEncodedCertificate

public HostnameConfiguration withEncodedCertificate(String encodedCertificate)

Set the encodedCertificate property: Base64 Encoded certificate.

Parameters:

encodedCertificate - the encodedCertificate value to set.

Returns:

the HostnameConfiguration object itself.

withHostname

public HostnameConfiguration withHostname(String hostname)

Set the hostname property: Hostname to configure on the Api Management service.

Parameters:

hostname - the hostname value to set.

Returns:

the HostnameConfiguration object itself.

withIdentityClientId

public HostnameConfiguration withIdentityClientId(String identityClientId)

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

Parameters:

identityClientId - the identityClientId value to set.

Returns:

the HostnameConfiguration object itself.

withKeyVaultId

public HostnameConfiguration withKeyVaultId(String keyVaultId)

Set the keyVaultId property: 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*.

Parameters:

keyVaultId - the keyVaultId value to set.

Returns:

the HostnameConfiguration object itself.

withNegotiateClientCertificate

public HostnameConfiguration withNegotiateClientCertificate(Boolean negotiateClientCertificate)

Set the negotiateClientCertificate property: 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 the type property: Hostname type.

Parameters:

type - the type value to set.

Returns:

the HostnameConfiguration object itself.