Share via


HostnameConfiguration Constructors

Definition

Overloads

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.

HostnameConfiguration()

Initializes a new instance of the HostnameConfiguration class.

public HostnameConfiguration ();
Public Sub New ()

Applies to

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

Initializes a new instance of the HostnameConfiguration class.

public HostnameConfiguration (string type, string hostName, string keyVaultId = default, string identityClientId = default, string encodedCertificate = default, string certificatePassword = default, bool? defaultSslBinding = default, bool? negotiateClientCertificate = default, Microsoft.Azure.Management.ApiManagement.Models.CertificateInformation certificate = default, string certificateSource = default, string certificateStatus = default);
new Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration : string * string * string * string * string * string * Nullable<bool> * Nullable<bool> * Microsoft.Azure.Management.ApiManagement.Models.CertificateInformation * string * string -> Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration
Public Sub New (type As String, hostName As String, Optional keyVaultId As String = Nothing, Optional identityClientId As String = Nothing, Optional encodedCertificate As String = Nothing, Optional certificatePassword As String = Nothing, Optional defaultSslBinding As Nullable(Of Boolean) = Nothing, Optional negotiateClientCertificate As Nullable(Of Boolean) = Nothing, Optional certificate As CertificateInformation = Nothing, Optional certificateSource As String = Nothing, Optional certificateStatus As String = Nothing)

Parameters

type
String

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

hostName
String

Hostname to configure on the Api Management service.

keyVaultId
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

identityClientId
String

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

encodedCertificate
String

Base64 Encoded certificate.

certificatePassword
String

Certificate Password.

defaultSslBinding
Nullable<Boolean>

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.

negotiateClientCertificate
Nullable<Boolean>

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

certificate
CertificateInformation

Certificate information.

certificateSource
String

Certificate Source. Possible values include: 'Managed', 'KeyVault', 'Custom', 'BuiltIn'

certificateStatus
String

Certificate Status. Possible values include: 'Completed', 'Failed', 'InProgress'

Applies to