HostnameConfiguration Class
- java.
lang. Object - com.
azure. resourcemanager. apimanagement. models. HostnameConfiguration
- com.
public final class HostnameConfiguration
Custom hostname configuration.
Constructor Summary
Constructor | Description |
---|---|
HostnameConfiguration() |
Creates an instance of Hostname |
Method Summary
Modifier and Type | Method and Description |
---|---|
Certificate |
certificate()
Get the certificate property: Certificate information. |
String |
certificatePassword()
Get the certificate |
Certificate |
certificateSource()
Get the certificate |
Certificate |
certificateStatus()
Get the certificate |
Boolean |
defaultSslBinding()
Get the default |
String |
encodedCertificate()
Get the encoded |
String |
hostname()
Get the hostname property: Hostname to configure on the Api Management service. |
String |
identityClientId()
Get the identity |
String |
keyVaultId()
Get the key |
Boolean |
negotiateClientCertificate()
Get the negotiate |
Hostname |
type()
Get the type property: Hostname type. |
void |
validate()
Validates the instance. |
Hostname |
withCertificate(CertificateInformation certificate)
Set the certificate property: Certificate information. |
Hostname |
withCertificatePassword(String certificatePassword)
Set the certificate |
Hostname |
withCertificateSource(CertificateSource certificateSource)
Set the certificate |
Hostname |
withCertificateStatus(CertificateStatus certificateStatus)
Set the certificate |
Hostname |
withDefaultSslBinding(Boolean defaultSslBinding)
Set the default |
Hostname |
withEncodedCertificate(String encodedCertificate)
Set the encoded |
Hostname |
withHostname(String hostname)
Set the hostname property: Hostname to configure on the Api Management service. |
Hostname |
withIdentityClientId(String identityClientId)
Set the identity |
Hostname |
withKeyVaultId(String keyVaultId)
Set the key |
Hostname |
withNegotiateClientCertificate(Boolean negotiateClientCertificate)
Set the negotiate |
Hostname |
withType(HostnameType type)
Set the type property: Hostname type. |
Methods inherited from java.lang.Object
Constructor Details
HostnameConfiguration
public HostnameConfiguration()
Creates an instance of HostnameConfiguration class.
Method Details
certificate
public CertificateInformation certificate()
Get the certificate property: Certificate information.
Returns:
certificatePassword
public String certificatePassword()
Get the certificatePassword property: Certificate Password.
Returns:
certificateSource
public CertificateSource certificateSource()
Get the certificateSource property: Certificate Source.
Returns:
certificateStatus
public CertificateStatus certificateStatus()
Get the certificateStatus property: Certificate Status.
Returns:
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:
encodedCertificate
public String encodedCertificate()
Get the encodedCertificate property: Base64 Encoded certificate.
Returns:
hostname
public String hostname()
Get the hostname property: Hostname to configure on the Api Management service.
Returns:
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:
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:
negotiateClientCertificate
public Boolean negotiateClientCertificate()
Get the negotiateClientCertificate property: Specify true to always negotiate client certificate on the hostname. Default Value is false.
Returns:
type
public HostnameType type()
Get the type property: Hostname type.
Returns:
validate
public void validate()
Validates the instance.
withCertificate
public HostnameConfiguration withCertificate(CertificateInformation certificate)
Set the certificate property: Certificate information.
Parameters:
Returns:
withCertificatePassword
public HostnameConfiguration withCertificatePassword(String certificatePassword)
Set the certificatePassword property: Certificate Password.
Parameters:
Returns:
withCertificateSource
public HostnameConfiguration withCertificateSource(CertificateSource certificateSource)
Set the certificateSource property: Certificate Source.
Parameters:
Returns:
withCertificateStatus
public HostnameConfiguration withCertificateStatus(CertificateStatus certificateStatus)
Set the certificateStatus property: Certificate Status.
Parameters:
Returns:
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:
Returns:
withEncodedCertificate
public HostnameConfiguration withEncodedCertificate(String encodedCertificate)
Set the encodedCertificate property: Base64 Encoded certificate.
Parameters:
Returns:
withHostname
public HostnameConfiguration withHostname(String hostname)
Set the hostname property: Hostname to configure on the Api Management service.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
withType
public HostnameConfiguration withType(HostnameType type)
Set the type property: Hostname type.
Parameters:
Returns:
Applies to
Azure SDK for Java