ApplicationGatewayProbeInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.39.0

• java.lang.Object
• • com.azure.core.management.SubResource
  • • com.azure.resourcemanager.network.fluent.models.ApplicationGatewayProbeInner

public final class ApplicationGatewayProbeInner
extends SubResource

Probe of the application gateway.

Constructor Summary

Constructor	Description
ApplicationGatewayProbeInner()	Creates an instance of ApplicationGatewayProbeInner 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.
String	host() Get the host property: Host name to send the probe to.
Integer	interval() Get the interval property: The probing interval in seconds.
ApplicationGatewayProbeHealthResponseMatch	match() Get the match property: Criterion for classifying a healthy probe response.
Integer	minServers() Get the minServers property: Minimum number of servers that are always marked healthy.
String	name() Get the name property: Name of the probe that is unique within an Application Gateway.
String	path() Get the path property: Relative path of probe.
Boolean	pickHostnameFromBackendHttpSettings() Get the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings.
Boolean	pickHostnameFromBackendSettings() Get the pickHostnameFromBackendSettings property: Whether the server name indication should be picked from the backend settings for Tls protocol.
Integer	port() Get the port property: Custom port which will be used for probing the backend servers.
ApplicationGatewayProtocol	protocol() Get the protocol property: The protocol used for the probe.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the probe resource.
Integer	timeout() Get the timeout property: The probe timeout in seconds.
String	type() Get the type property: Type of the resource.
Integer	unhealthyThreshold() Get the unhealthyThreshold property: The probe retry count.
void	validate() Validates the instance.
ApplicationGatewayProbeInner	withHost(String host) Set the host property: Host name to send the probe to.
ApplicationGatewayProbeInner	withId(String id)
ApplicationGatewayProbeInner	withInterval(Integer interval) Set the interval property: The probing interval in seconds.
ApplicationGatewayProbeInner	withMatch(ApplicationGatewayProbeHealthResponseMatch match) Set the match property: Criterion for classifying a healthy probe response.
ApplicationGatewayProbeInner	withMinServers(Integer minServers) Set the minServers property: Minimum number of servers that are always marked healthy.
ApplicationGatewayProbeInner	withName(String name) Set the name property: Name of the probe that is unique within an Application Gateway.
ApplicationGatewayProbeInner	withPath(String path) Set the path property: Relative path of probe.
ApplicationGatewayProbeInner	withPickHostnameFromBackendHttpSettings(Boolean pickHostnameFromBackendHttpSettings) Set the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings.
ApplicationGatewayProbeInner	withPickHostnameFromBackendSettings(Boolean pickHostnameFromBackendSettings) Set the pickHostnameFromBackendSettings property: Whether the server name indication should be picked from the backend settings for Tls protocol.
ApplicationGatewayProbeInner	withPort(Integer port) Set the port property: Custom port which will be used for probing the backend servers.
ApplicationGatewayProbeInner	withProtocol(ApplicationGatewayProtocol protocol) Set the protocol property: The protocol used for the probe.
ApplicationGatewayProbeInner	withTimeout(Integer timeout) Set the timeout property: The probe timeout in seconds.
ApplicationGatewayProbeInner	withUnhealthyThreshold(Integer unhealthyThreshold) Set the unhealthyThreshold property: The probe retry count.

Methods inherited from SubResource

id withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApplicationGatewayProbeInner

public ApplicationGatewayProbeInner()

Creates an instance of ApplicationGatewayProbeInner 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.

host

public String host()

Get the host property: Host name to send the probe to.

Returns:

the host value.

interval

public Integer interval()

Get the interval property: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

Returns:

the interval value.

match

public ApplicationGatewayProbeHealthResponseMatch match()

Get the match property: Criterion for classifying a healthy probe response.

Returns:

the match value.

minServers

public Integer minServers()

Get the minServers property: Minimum number of servers that are always marked healthy. Default value is 0.

Returns:

the minServers value.

name

public String name()

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

Returns:

the name value.

path

public String path()

Get the path property: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

Returns:

the path value.

pickHostnameFromBackendHttpSettings

public Boolean pickHostnameFromBackendHttpSettings()

Get the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings. Default value is false.

Returns:

the pickHostnameFromBackendHttpSettings value.

pickHostnameFromBackendSettings

public Boolean pickHostnameFromBackendSettings()

Get the pickHostnameFromBackendSettings property: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.

Returns:

the pickHostnameFromBackendSettings value.

port

public Integer port()

Get the port property: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only.

Returns:

the port value.

protocol

public ApplicationGatewayProtocol protocol()

Get the protocol property: The protocol used for the probe.

Returns:

the protocol value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the probe resource.

Returns:

the provisioningState value.

timeout

public Integer timeout()

Get the timeout property: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

Returns:

the timeout value.

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

unhealthyThreshold

public Integer unhealthyThreshold()

Get the unhealthyThreshold property: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

Returns:

the unhealthyThreshold value.

validate

public void validate()

Validates the instance.

withHost

public ApplicationGatewayProbeInner withHost(String host)

Set the host property: Host name to send the probe to.

Parameters:

host - the host value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withId

public ApplicationGatewayProbeInner withId(String id)

Overrides:

ApplicationGatewayProbeInner.withId(String id)

Parameters:

id

withInterval

public ApplicationGatewayProbeInner withInterval(Integer interval)

Set the interval property: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

Parameters:

interval - the interval value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withMatch

public ApplicationGatewayProbeInner withMatch(ApplicationGatewayProbeHealthResponseMatch match)

Set the match property: Criterion for classifying a healthy probe response.

Parameters:

match - the match value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withMinServers

public ApplicationGatewayProbeInner withMinServers(Integer minServers)

Set the minServers property: Minimum number of servers that are always marked healthy. Default value is 0.

Parameters:

minServers - the minServers value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withName

public ApplicationGatewayProbeInner withName(String name)

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

Parameters:

name - the name value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withPath

public ApplicationGatewayProbeInner withPath(String path)

Set the path property: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

Parameters:

path - the path value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withPickHostnameFromBackendHttpSettings

public ApplicationGatewayProbeInner withPickHostnameFromBackendHttpSettings(Boolean pickHostnameFromBackendHttpSettings)

Set the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings. Default value is false.

Parameters:

pickHostnameFromBackendHttpSettings - the pickHostnameFromBackendHttpSettings value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withPickHostnameFromBackendSettings

public ApplicationGatewayProbeInner withPickHostnameFromBackendSettings(Boolean pickHostnameFromBackendSettings)

Set the pickHostnameFromBackendSettings property: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.

Parameters:

pickHostnameFromBackendSettings - the pickHostnameFromBackendSettings value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withPort

public ApplicationGatewayProbeInner withPort(Integer port)

Set the port property: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only.

Parameters:

port - the port value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withProtocol

public ApplicationGatewayProbeInner withProtocol(ApplicationGatewayProtocol protocol)

Set the protocol property: The protocol used for the probe.

Parameters:

protocol - the protocol value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withTimeout

public ApplicationGatewayProbeInner withTimeout(Integer timeout)

Set the timeout property: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the ApplicationGatewayProbeInner object itself.

withUnhealthyThreshold

public ApplicationGatewayProbeInner withUnhealthyThreshold(Integer unhealthyThreshold)

Set the unhealthyThreshold property: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

Parameters:

unhealthyThreshold - the unhealthyThreshold value to set.

Returns:

the ApplicationGatewayProbeInner object itself.