Share via


HostnameConfiguration Class

Definition

Custom hostname configuration.

public class HostnameConfiguration
type HostnameConfiguration = class
Public Class HostnameConfiguration
Inheritance
HostnameConfiguration

Constructors

HostnameConfiguration()

Initializes a new instance of the HostnameConfiguration class.

HostnameConfiguration(String, String, String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, CertificateInformation, String, String)

Initializes a new instance of the HostnameConfiguration class.

Properties

Certificate

Gets or sets certificate information.

CertificatePassword

Gets or sets certificate Password.

CertificateSource

Gets or sets certificate Source. Possible values include: 'Managed', 'KeyVault', 'Custom', 'BuiltIn'

CertificateStatus

Gets or sets certificate Status. Possible values include: 'Completed', 'Failed', 'InProgress'

DefaultSslBinding

Gets or sets 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.

EncodedCertificate

Gets or sets base64 Encoded certificate.

HostName

Gets or sets hostname to configure on the Api Management service.

IdentityClientId

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

KeyVaultId

Gets or sets 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

Gets or sets specify true to always negotiate client certificate on the hostname. Default Value is false.

Type

Gets or sets hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'

Methods

Validate()

Validate the object.

Applies to