HostnameConfiguration Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Custom hostname configuration.
public class HostnameConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.HostnameConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.HostnameConfiguration>
type HostnameConfiguration = class
interface IJsonModel<HostnameConfiguration>
interface IPersistableModel<HostnameConfiguration>
Public Class HostnameConfiguration
Implements IJsonModel(Of HostnameConfiguration), IPersistableModel(Of HostnameConfiguration)
- Inheritance
-
HostnameConfiguration
- Implements
Constructors
HostnameConfiguration(HostnameType, String) |
Initializes a new instance of HostnameConfiguration. |
Properties
Certificate |
Certificate information. |
CertificatePassword |
Certificate Password. |
CertificateSource |
Certificate Source. |
CertificateStatus |
Certificate Status. |
EncodedCertificate |
Base64 Encoded certificate. |
HostName |
Hostname to configure on the Api Management service. |
HostnameType |
Hostname type. |
IdentityClientId |
System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. |
IsClientCertificateNegotiationEnabled |
Specify true to always negotiate client certificate on the hostname. Default Value is false. |
IsDefaultSslBindingEnabled |
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. |
KeyVaultSecretUri |
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. |
Explicit Interface Implementations
IJsonModel<HostnameConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<HostnameConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<HostnameConfiguration>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<HostnameConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<HostnameConfiguration>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |