228 строки
18 KiB
YAML
228 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration"
|
|
name: "HostnameConfiguration"
|
|
nameWithType: "HostnameConfiguration"
|
|
summary: "Custom hostname configuration."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **HostnameConfiguration**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.HostnameConfiguration()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.HostnameConfiguration()"
|
|
name: "HostnameConfiguration()"
|
|
nameWithType: "HostnameConfiguration.HostnameConfiguration()"
|
|
syntax: "public HostnameConfiguration()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.certificate()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.certificate()"
|
|
name: "certificate()"
|
|
nameWithType: "HostnameConfiguration.certificate()"
|
|
summary: "Get certificate information."
|
|
syntax: "public CertificateInformation certificate()"
|
|
desc: "Get certificate information."
|
|
returns:
|
|
description: "the certificate value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateInformation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateInformation&text=CertificateInformation\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.certificatePassword()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.certificatePassword()"
|
|
name: "certificatePassword()"
|
|
nameWithType: "HostnameConfiguration.certificatePassword()"
|
|
summary: "Get certificate Password."
|
|
syntax: "public String certificatePassword()"
|
|
desc: "Get certificate Password."
|
|
returns:
|
|
description: "the certificatePassword value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.defaultSslBinding()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.defaultSslBinding()"
|
|
name: "defaultSslBinding()"
|
|
nameWithType: "HostnameConfiguration.defaultSslBinding()"
|
|
summary: "Get specify true to setup the certificate associated with this Hostname as the Default SSL Certificate."
|
|
syntax: "public Boolean defaultSslBinding()"
|
|
desc: "Get 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."
|
|
returns:
|
|
description: "the defaultSslBinding value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.encodedCertificate()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.encodedCertificate()"
|
|
name: "encodedCertificate()"
|
|
nameWithType: "HostnameConfiguration.encodedCertificate()"
|
|
summary: "Get base64 Encoded certificate."
|
|
syntax: "public String encodedCertificate()"
|
|
desc: "Get base64 Encoded certificate."
|
|
returns:
|
|
description: "the encodedCertificate value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.hostName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.hostName()"
|
|
name: "hostName()"
|
|
nameWithType: "HostnameConfiguration.hostName()"
|
|
summary: "Get hostname to configure on the Api Management service."
|
|
syntax: "public String hostName()"
|
|
desc: "Get hostname to configure on the Api Management service."
|
|
returns:
|
|
description: "the hostName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.keyVaultId()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.keyVaultId()"
|
|
name: "keyVaultId()"
|
|
nameWithType: "HostnameConfiguration.keyVaultId()"
|
|
summary: "Get url to the Key<wbr>Vault Secret containing the Ssl Certificate."
|
|
syntax: "public String keyVaultId()"
|
|
desc: "Get 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\\*."
|
|
returns:
|
|
description: "the keyVaultId value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.negotiateClientCertificate()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.negotiateClientCertificate()"
|
|
name: "negotiateClientCertificate()"
|
|
nameWithType: "HostnameConfiguration.negotiateClientCertificate()"
|
|
summary: "Get specify true to always negotiate client certificate on the hostname."
|
|
syntax: "public Boolean negotiateClientCertificate()"
|
|
desc: "Get specify true to always negotiate client certificate on the hostname. Default Value is false."
|
|
returns:
|
|
description: "the negotiateClientCertificate value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.type()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.type()"
|
|
name: "type()"
|
|
nameWithType: "HostnameConfiguration.type()"
|
|
summary: "Get hostname type."
|
|
syntax: "public HostnameType type()"
|
|
desc: "Get hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'."
|
|
returns:
|
|
description: "the type value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameType&text=HostnameType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withCertificate(com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateInformation)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withCertificate(CertificateInformation certificate)"
|
|
name: "withCertificate(CertificateInformation certificate)"
|
|
nameWithType: "HostnameConfiguration.withCertificate(CertificateInformation certificate)"
|
|
summary: "Set certificate information."
|
|
parameters:
|
|
- description: "the certificate value to set"
|
|
name: "certificate"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateInformation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateInformation&text=CertificateInformation\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withCertificate(CertificateInformation certificate)"
|
|
desc: "Set certificate information."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withCertificatePassword(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withCertificatePassword(String certificatePassword)"
|
|
name: "withCertificatePassword(String certificatePassword)"
|
|
nameWithType: "HostnameConfiguration.withCertificatePassword(String certificatePassword)"
|
|
summary: "Set certificate Password."
|
|
parameters:
|
|
- description: "the certificatePassword value to set"
|
|
name: "certificatePassword"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withCertificatePassword(String certificatePassword)"
|
|
desc: "Set certificate Password."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withDefaultSslBinding(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withDefaultSslBinding(Boolean defaultSslBinding)"
|
|
name: "withDefaultSslBinding(Boolean defaultSslBinding)"
|
|
nameWithType: "HostnameConfiguration.withDefaultSslBinding(Boolean defaultSslBinding)"
|
|
summary: "Set specify true to setup the certificate associated with this Hostname as the Default SSL Certificate."
|
|
parameters:
|
|
- description: "the defaultSslBinding value to set"
|
|
name: "defaultSslBinding"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withDefaultSslBinding(Boolean defaultSslBinding)"
|
|
desc: "Set 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."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withEncodedCertificate(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withEncodedCertificate(String encodedCertificate)"
|
|
name: "withEncodedCertificate(String encodedCertificate)"
|
|
nameWithType: "HostnameConfiguration.withEncodedCertificate(String encodedCertificate)"
|
|
summary: "Set base64 Encoded certificate."
|
|
parameters:
|
|
- description: "the encodedCertificate value to set"
|
|
name: "encodedCertificate"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withEncodedCertificate(String encodedCertificate)"
|
|
desc: "Set base64 Encoded certificate."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withHostName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withHostName(String hostName)"
|
|
name: "withHostName(String hostName)"
|
|
nameWithType: "HostnameConfiguration.withHostName(String hostName)"
|
|
summary: "Set hostname to configure on the Api Management service."
|
|
parameters:
|
|
- description: "the hostName value to set"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withHostName(String hostName)"
|
|
desc: "Set hostname to configure on the Api Management service."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withKeyVaultId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withKeyVaultId(String keyVaultId)"
|
|
name: "withKeyVaultId(String keyVaultId)"
|
|
nameWithType: "HostnameConfiguration.withKeyVaultId(String keyVaultId)"
|
|
summary: "Set url to the Key<wbr>Vault Secret containing the Ssl Certificate."
|
|
parameters:
|
|
- description: "the keyVaultId value to set"
|
|
name: "keyVaultId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withKeyVaultId(String keyVaultId)"
|
|
desc: "Set 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\\*."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withNegotiateClientCertificate(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withNegotiateClientCertificate(Boolean negotiateClientCertificate)"
|
|
name: "withNegotiateClientCertificate(Boolean negotiateClientCertificate)"
|
|
nameWithType: "HostnameConfiguration.withNegotiateClientCertificate(Boolean negotiateClientCertificate)"
|
|
summary: "Set specify true to always negotiate client certificate on the hostname."
|
|
parameters:
|
|
- description: "the negotiateClientCertificate value to set"
|
|
name: "negotiateClientCertificate"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withNegotiateClientCertificate(Boolean negotiateClientCertificate)"
|
|
desc: "Set specify true to always negotiate client certificate on the hostname. Default Value is false."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withType(com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameType)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration.withType(HostnameType type)"
|
|
name: "withType(HostnameType type)"
|
|
nameWithType: "HostnameConfiguration.withType(HostnameType type)"
|
|
summary: "Set hostname type."
|
|
parameters:
|
|
- description: "the type value to set"
|
|
name: "type"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameType&text=HostnameType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HostnameConfiguration withType(HostnameType type)"
|
|
desc: "Set hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'."
|
|
returns:
|
|
description: "the HostnameConfiguration object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Custom hostname configuration."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|