Share via

ApplicationGatewayBackendSettings Class

  • Reference
Package:
com.azure.resourcemanager.network.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.44.0

public final class ApplicationGatewayBackendSettings
extends SubResource

Backend address pool settings of an application gateway.

Constructor Summary

Constructor Description
ApplicationGatewayBackendSettings()

Creates an instance of ApplicationGatewayBackendSettings class.

Method Summary

Modifier and Type Method and Description
String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.
static ApplicationGatewayBackendSettings fromJson(JsonReader jsonReader)

Reads an instance of ApplicationGatewayBackendSettings from the JsonReader.
String hostname()

Get the hostname property: Server name indication to be sent to the backend servers for Tls protocol.
String name()

Get the name property: Name of the backend settings that is unique within an Application Gateway.
Boolean pickHostnameFromBackendAddress()

Get the pickHostnameFromBackendAddress property: Whether to pick server name indication from the host name of the backend server for Tls protocol.
Integer port()

Get the port property: The destination port on the backend.
SubResource probe()

Get the probe property: Probe resource of an application gateway.
ApplicationGatewayProtocol protocol()

Get the protocol property: The protocol used to communicate with the backend.
ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the backend HTTP settings resource.
Integer timeout()

Get the timeout property: Connection timeout in seconds.
JsonWriter toJson(JsonWriter jsonWriter)
List<SubResource> trustedRootCertificates()

Get the trustedRootCertificates property: Array of references to application gateway trusted root certificates.
String type()

Get the type property: Type of the resource.
void validate()

Validates the instance.
ApplicationGatewayBackendSettings withHostname(String hostname)

Set the hostname property: Server name indication to be sent to the backend servers for Tls protocol.
ApplicationGatewayBackendSettings withId(String id)
ApplicationGatewayBackendSettings withName(String name)

Set the name property: Name of the backend settings that is unique within an Application Gateway.
ApplicationGatewayBackendSettings withPickHostnameFromBackendAddress(Boolean pickHostnameFromBackendAddress)

Set the pickHostnameFromBackendAddress property: Whether to pick server name indication from the host name of the backend server for Tls protocol.
ApplicationGatewayBackendSettings withPort(Integer port)

Set the port property: The destination port on the backend.
ApplicationGatewayBackendSettings withProbe(SubResource probe)

Set the probe property: Probe resource of an application gateway.
ApplicationGatewayBackendSettings withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol property: The protocol used to communicate with the backend.
ApplicationGatewayBackendSettings withTimeout(Integer timeout)

Set the timeout property: Connection timeout in seconds.
ApplicationGatewayBackendSettings withTrustedRootCertificates(List<SubResource> trustedRootCertificates)

Set the trustedRootCertificates property: Array of references to application gateway trusted root certificates.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApplicationGatewayBackendSettings

public ApplicationGatewayBackendSettings()

Creates an instance of ApplicationGatewayBackendSettings class.

Method Details

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static ApplicationGatewayBackendSettings fromJson(JsonReader jsonReader)

Reads an instance of ApplicationGatewayBackendSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApplicationGatewayBackendSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ApplicationGatewayBackendSettings.

hostname

public String hostname()

Get the hostname property: Server name indication to be sent to the backend servers for Tls protocol.

Returns:

the hostname value.

name

public String name()

Get the name property: Name of the backend settings that is unique within an Application Gateway.

Returns:

the name value.

pickHostnameFromBackendAddress

public Boolean pickHostnameFromBackendAddress()

Get the pickHostnameFromBackendAddress property: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.

Returns:

the pickHostnameFromBackendAddress value.

port

public Integer port()

Get the port property: The destination port on the backend.

Returns:

the port value.

probe

public SubResource probe()

Get the probe property: Probe resource of an application gateway.

Returns:

the probe value.

protocol

public ApplicationGatewayProtocol protocol()

Get the protocol property: The protocol used to communicate with the backend.

Returns:

the protocol value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the backend HTTP settings resource.

Returns:

the provisioningState value.

timeout

public Integer timeout()

Get the timeout property: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.

Returns:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ApplicationGatewayBackendSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

trustedRootCertificates

public List trustedRootCertificates()

Get the trustedRootCertificates property: Array of references to application gateway trusted root certificates.

Returns:

the trustedRootCertificates value.

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withHostname

public ApplicationGatewayBackendSettings withHostname(String hostname)

Set the hostname property: Server name indication to be sent to the backend servers for Tls protocol.

Parameters:

hostname - the hostname value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withId

public ApplicationGatewayBackendSettings withId(String id)

Overrides:

ApplicationGatewayBackendSettings.withId(String id)

Parameters:

id

withName

public ApplicationGatewayBackendSettings withName(String name)

Set the name property: Name of the backend settings that is unique within an Application Gateway.

Parameters:

name - the name value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withPickHostnameFromBackendAddress

public ApplicationGatewayBackendSettings withPickHostnameFromBackendAddress(Boolean pickHostnameFromBackendAddress)

Set the pickHostnameFromBackendAddress property: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.

Parameters:

pickHostnameFromBackendAddress - the pickHostnameFromBackendAddress value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withPort

public ApplicationGatewayBackendSettings withPort(Integer port)

Set the port property: The destination port on the backend.

Parameters:

port - the port value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withProbe

public ApplicationGatewayBackendSettings withProbe(SubResource probe)

Set the probe property: Probe resource of an application gateway.

Parameters:

probe - the probe value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withProtocol

public ApplicationGatewayBackendSettings withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol property: The protocol used to communicate with the backend.

Parameters:

protocol - the protocol value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withTimeout

public ApplicationGatewayBackendSettings withTimeout(Integer timeout)

Set the timeout property: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

withTrustedRootCertificates

public ApplicationGatewayBackendSettings withTrustedRootCertificates(List trustedRootCertificates)

Set the trustedRootCertificates property: Array of references to application gateway trusted root certificates.

Parameters:

trustedRootCertificates - the trustedRootCertificates value to set.

Returns:

the ApplicationGatewayBackendSettings object itself.

Applies to