ApplicationGatewayProbe Interface
Implements
public interface ApplicationGatewayProbe
extends HasInnerModel<ApplicationGatewayProbeInner>, ChildResource<ApplicationGateway>, HasProtocol<ApplicationGatewayProtocol>
A client-side representation of an application gateway probe.
Method Summary
Modifier and Type | Method and Description |
---|---|
abstract String |
healthyHttpResponseBodyContents()
Gets the body contents of an HTTP response to a probe to check for to determine backend health, or null if none specified |
abstract Set<String> |
healthyHttpResponseStatusCodeRanges()
Gets HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy. |
abstract String |
host()
Gets host name to send the probe to. |
abstract Boolean |
isHostNameFromBackendHttpSettings()
Checks whether probe uses the host name from the HTTP settings to which this probe is associated. |
abstract String |
path()
Gets the relative path to be called by the probe. |
abstract int |
retriesBeforeUnhealthy()
Gets the number of failed retry probes before the backend server is marked as being down. |
abstract int |
timeBetweenProbesInSeconds()
Gets the number of seconds between probe retries. |
abstract int |
timeoutInSeconds()
Gets the number of seconds waiting for a response after which the probe times out and it is marked as failed. |
Method Details
healthyHttpResponseBodyContents
public abstract String healthyHttpResponseBodyContents()
Gets the body contents of an HTTP response to a probe to check for to determine backend health, or null if none specified
Returns:
healthyHttpResponseStatusCodeRanges
public abstract Set
Gets HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy.
Returns:
host
public abstract String host()
Gets host name to send the probe to.
Returns:
isHostNameFromBackendHttpSettings
public abstract Boolean isHostNameFromBackendHttpSettings()
Checks whether probe uses the host name from the HTTP settings to which this probe is associated.
Returns:
path
public abstract String path()
Gets the relative path to be called by the probe.
Returns:
retriesBeforeUnhealthy
public abstract int retriesBeforeUnhealthy()
Gets the number of failed retry probes before the backend server is marked as being down.
Returns:
Acceptable values are from 1 second to 20.
timeBetweenProbesInSeconds
public abstract int timeBetweenProbesInSeconds()
Gets the number of seconds between probe retries.
Returns:
timeoutInSeconds
public abstract int timeoutInSeconds()
Gets the number of seconds waiting for a response after which the probe times out and it is marked as failed.
Returns:
Acceptable values are from 1 to 86400 seconds.