Class HostnameConfiguration

Custom hostname configuration.

Inheritance

Object

HostnameConfiguration

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.ApiManagement.dll

Syntax

public class HostnameConfiguration

Constructors

HostnameConfiguration()

Initializes a new instance of the HostnameConfiguration class.

Declaration

public HostnameConfiguration ();

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

Initializes a new instance of the HostnameConfiguration class.

Declaration

public HostnameConfiguration (string type, string hostName, string keyVaultId = null, string encodedCertificate = null, string certificatePassword = null, Nullable<bool> defaultSslBinding = null, Nullable<bool> negotiateClientCertificate = null, Microsoft.Azure.Management.ApiManagement.Models.CertificateInformation certificate = null);

Parameters

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

String hostName Hostname to configure on the Api Management service.

String keyVaultId 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

String encodedCertificate Base64 Encoded certificate.

String certificatePassword Certificate Password.

Nullable<Boolean> defaultSslBinding 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.

Nullable<Boolean> negotiateClientCertificate Specify true to always negotiate client certificate on the hostname. Default Value is false.

CertificateInformation certificate Certificate information.

Properties

Certificate

Gets or sets certificate information.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="certificate")]
public Microsoft.Azure.Management.ApiManagement.Models.CertificateInformation Certificate { get; set; }

Property Value

CertificateInformation

CertificatePassword

Gets or sets certificate Password.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="certificatePassword")]
public string CertificatePassword { get; set; }

Property Value

String

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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="defaultSslBinding")]
public Nullable<bool> DefaultSslBinding { get; set; }

Property Value

Nullable<Boolean>

EncodedCertificate

Gets or sets base64 Encoded certificate.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="encodedCertificate")]
public string EncodedCertificate { get; set; }

Property Value

String

HostName

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="hostName")]
public string HostName { get; set; }

Property Value

String

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="keyVaultId")]
public string KeyVaultId { get; set; }

Property Value

String

NegotiateClientCertificate

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="negotiateClientCertificate")]
public Nullable<bool> NegotiateClientCertificate { get; set; }

Property Value

Nullable<Boolean>

Type

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="type")]
public string Type { get; set; }

Property Value

String

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException Thrown if validation fails