ApplicationGatewayBackendHttpSettings Class

Package:

com.microsoft.azure.management.network

Maven Artifact:

com.microsoft.azure:azure-mgmt-network:1.41.4

• java.lang.Object
• • com.microsoft.azure.SubResource
  • • com.microsoft.azure.management.network.ApplicationGatewayBackendHttpSettings

public class ApplicationGatewayBackendHttpSettings
extends com.microsoft.azure.SubResource

Backend address pool settings of an application gateway.

Constructor Summary

Constructor	Description
ApplicationGatewayBackendHttpSettings()

Method Summary

Modifier and Type	Method and Description
java.lang.String	affinityCookieName() Get cookie name to use for the affinity cookie.
java.util.List<com.microsoft.azure.SubResource>	authenticationCertificates() Get array of references to application gateway authentication certificates.
ApplicationGatewayConnectionDraining	connectionDraining() Get connection draining of the backend http settings resource.
ApplicationGatewayCookieBasedAffinity	cookieBasedAffinity() Get cookie based affinity.
java.lang.String	etag() Get a unique read-only string that changes whenever the resource is updated.
java.lang.String	hostName() Get host header to be sent to the backend servers.
java.lang.String	name() Get name of the backend http settings that is unique within an Application Gateway.
java.lang.String	path() Get path which should be used as a prefix for all HTTP requests.
java.lang.Boolean	pickHostNameFromBackendAddress() Get whether to pick host header should be picked from the host name of the backend server.
java.lang.Integer	port() Get the destination port on the backend.
com.microsoft.azure.SubResource	probe() Get probe resource of an application gateway.
java.lang.Boolean	probeEnabled() Get whether the probe is enabled.
ApplicationGatewayProtocol	protocol() Get the protocol used to communicate with the backend.
ProvisioningState	provisioningState() Get the provisioning state of the backend HTTP settings resource.
java.lang.Integer	requestTimeout() Get request timeout in seconds.
java.util.List<com.microsoft.azure.SubResource>	trustedRootCertificates() Get array of references to application gateway trusted root certificates.
java.lang.String	type() Get type of the resource.
ApplicationGatewayBackendHttpSettings	withAffinityCookieName(String affinityCookieName) Set cookie name to use for the affinity cookie.
ApplicationGatewayBackendHttpSettings	withAuthenticationCertificates(List<SubResource> authenticationCertificates) Set array of references to application gateway authentication certificates.
ApplicationGatewayBackendHttpSettings	withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining) Set connection draining of the backend http settings resource.
ApplicationGatewayBackendHttpSettings	withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity) Set cookie based affinity.
ApplicationGatewayBackendHttpSettings	withHostName(String hostName) Set host header to be sent to the backend servers.
ApplicationGatewayBackendHttpSettings	withName(String name) Set name of the backend http settings that is unique within an Application Gateway.
ApplicationGatewayBackendHttpSettings	withPath(String path) Set path which should be used as a prefix for all HTTP requests.
ApplicationGatewayBackendHttpSettings	withPickHostNameFromBackendAddress(Boolean pickHostNameFromBackendAddress) Set whether to pick host header should be picked from the host name of the backend server.
ApplicationGatewayBackendHttpSettings	withPort(Integer port) Set the destination port on the backend.
ApplicationGatewayBackendHttpSettings	withProbe(SubResource probe) Set probe resource of an application gateway.
ApplicationGatewayBackendHttpSettings	withProbeEnabled(Boolean probeEnabled) Set whether the probe is enabled.
ApplicationGatewayBackendHttpSettings	withProtocol(ApplicationGatewayProtocol protocol) Set the protocol used to communicate with the backend.
ApplicationGatewayBackendHttpSettings	withRequestTimeout(Integer requestTimeout) Set request timeout in seconds.
ApplicationGatewayBackendHttpSettings	withTrustedRootCertificates(List<SubResource> trustedRootCertificates) Set array of references to application gateway trusted root certificates.

Methods inherited from com.microsoft.azure.SubResource

com.microsoft.azure.SubResource.id com.microsoft.azure.SubResource.withId

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ApplicationGatewayBackendHttpSettings

public ApplicationGatewayBackendHttpSettings()

Method Details

affinityCookieName

public String affinityCookieName()

Get cookie name to use for the affinity cookie.

Returns:

the affinityCookieName value

authenticationCertificates

public List authenticationCertificates()

Get array of references to application gateway authentication certificates.

Returns:

the authenticationCertificates value

connectionDraining

public ApplicationGatewayConnectionDraining connectionDraining()

Get connection draining of the backend http settings resource.

Returns:

the connectionDraining value

cookieBasedAffinity

public ApplicationGatewayCookieBasedAffinity cookieBasedAffinity()

Get cookie based affinity. Possible values include: 'Enabled', 'Disabled'.

Returns:

the cookieBasedAffinity value

etag

public String etag()

Get a unique read-only string that changes whenever the resource is updated.

Returns:

the etag value

hostName

public String hostName()

Get host header to be sent to the backend servers.

Returns:

the hostName value

name

public String name()

Get name of the backend http settings that is unique within an Application Gateway.

Returns:

the name value

path

public String path()

Get path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

Returns:

the path value

pickHostNameFromBackendAddress

public Boolean pickHostNameFromBackendAddress()

Get whether to pick host header should be picked from the host name of the backend server. Default value is false.

Returns:

the pickHostNameFromBackendAddress value

port

public Integer port()

Get the destination port on the backend.

Returns:

the port value

probe

public SubResource probe()

Get probe resource of an application gateway.

Returns:

the probe value

probeEnabled

public Boolean probeEnabled()

Get whether the probe is enabled. Default value is false.

Returns:

the probeEnabled value

protocol

public ApplicationGatewayProtocol protocol()

Get the protocol used to communicate with the backend. Possible values include: 'Http', 'Https'.

Returns:

the protocol value

provisioningState

public ProvisioningState provisioningState()

Get the provisioning state of the backend HTTP settings resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.

Returns:

the provisioningState value

requestTimeout

public Integer requestTimeout()

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

Returns:

the requestTimeout value

trustedRootCertificates

public List trustedRootCertificates()

Get array of references to application gateway trusted root certificates.

Returns:

the trustedRootCertificates value

type

public String type()

Get type of the resource.

Returns:

the type value

withAffinityCookieName

public ApplicationGatewayBackendHttpSettings withAffinityCookieName(String affinityCookieName)

Set cookie name to use for the affinity cookie.

Parameters:

affinityCookieName - the affinityCookieName value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withAuthenticationCertificates

public ApplicationGatewayBackendHttpSettings withAuthenticationCertificates(List authenticationCertificates)

Set array of references to application gateway authentication certificates.

Parameters:

authenticationCertificates - the authenticationCertificates value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withConnectionDraining

public ApplicationGatewayBackendHttpSettings withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)

Set connection draining of the backend http settings resource.

Parameters:

connectionDraining - the connectionDraining value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withCookieBasedAffinity

public ApplicationGatewayBackendHttpSettings withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)

Set cookie based affinity. Possible values include: 'Enabled', 'Disabled'.

Parameters:

cookieBasedAffinity - the cookieBasedAffinity value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withHostName

public ApplicationGatewayBackendHttpSettings withHostName(String hostName)

Set host header to be sent to the backend servers.

Parameters:

hostName - the hostName value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withName

public ApplicationGatewayBackendHttpSettings withName(String name)

Set name of the backend http settings that is unique within an Application Gateway.

Parameters:

name - the name value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPath

public ApplicationGatewayBackendHttpSettings withPath(String path)

Set path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

Parameters:

path - the path value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPickHostNameFromBackendAddress

public ApplicationGatewayBackendHttpSettings withPickHostNameFromBackendAddress(Boolean pickHostNameFromBackendAddress)

Set whether to pick host header should be picked from the host name of the backend server. Default value is false.

Parameters:

pickHostNameFromBackendAddress - the pickHostNameFromBackendAddress value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withPort

public ApplicationGatewayBackendHttpSettings withPort(Integer port)

Set the destination port on the backend.

Parameters:

port - the port value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProbe

public ApplicationGatewayBackendHttpSettings withProbe(SubResource probe)

Set probe resource of an application gateway.

Parameters:

probe - the probe value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProbeEnabled

public ApplicationGatewayBackendHttpSettings withProbeEnabled(Boolean probeEnabled)

Set whether the probe is enabled. Default value is false.

Parameters:

probeEnabled - the probeEnabled value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withProtocol

public ApplicationGatewayBackendHttpSettings withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol used to communicate with the backend. Possible values include: 'Http', 'Https'.

Parameters:

protocol - the protocol value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withRequestTimeout

public ApplicationGatewayBackendHttpSettings withRequestTimeout(Integer requestTimeout)

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

Parameters:

requestTimeout - the requestTimeout value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.

withTrustedRootCertificates

public ApplicationGatewayBackendHttpSettings withTrustedRootCertificates(List trustedRootCertificates)

Set array of references to application gateway trusted root certificates.

Parameters:

trustedRootCertificates - the trustedRootCertificates value to set

Returns:

the ApplicationGatewayBackendHttpSettings object itself.