Interface ApplicationGatewayProbe
- All Superinterfaces:
ChildResource<ApplicationGateway>,HasInnerModel<ApplicationGatewayProbeInner>,HasName,HasParent<ApplicationGateway>,HasProtocol<ApplicationGatewayProtocol>,Indexable
public interface ApplicationGatewayProbe
extends HasInnerModel<ApplicationGatewayProbeInner>, ChildResource<ApplicationGateway>, HasProtocol<ApplicationGatewayProtocol>
A client-side representation of an application gateway probe.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of an application gateway probe definition.static interfaceGrouping of application gateway probe definition stages.static interfaceThe entirety of an application gateway probe update as part of an application gateway update.static interfaceThe entirety of an application gateway probe definition as part of an application gateway update.static interfaceGrouping of application gateway probe definition stages applicable as part of an application gateway update.static interfaceGrouping of application gateway probe update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the body contents of an HTTP response to a probe to check for to determine backend health, or null if none specifiedGets HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy.host()Gets host name to send the probe to.Checks whether probe uses the host name from the HTTP settings to which this probe is associated.path()Gets the relative path to be called by the probe.intGets the number of failed retry probes before the backend server is marked as being down.intGets the number of seconds between probe retries.intGets the number of seconds waiting for a response after which the probe times out and it is marked as failed.Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModelMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
nameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent
parentMethods inherited from interface com.azure.resourcemanager.network.models.HasProtocol
protocol
-
Method Details
-
timeBetweenProbesInSeconds
int timeBetweenProbesInSeconds()Gets the number of seconds between probe retries.- Returns:
- the number of seconds between probe retries
-
healthyHttpResponseStatusCodeRanges
Gets HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy.- Returns:
- HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy.
-
healthyHttpResponseBodyContents
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:
- the body contents of an HTTP response to a probe to check for to determine backend health, or null if none specified
-
path
String path()Gets the relative path to be called by the probe.- Returns:
- the relative path to be called by the probe
-
timeoutInSeconds
int timeoutInSeconds()Gets the number of seconds waiting for a response after which the probe times out and it is marked as failed.- Returns:
- the number of seconds waiting for a response after which the probe times out and it is marked as failed
Acceptable values are from 1 to 86400 seconds.
-
retriesBeforeUnhealthy
int retriesBeforeUnhealthy()Gets the number of failed retry probes before the backend server is marked as being down.- Returns:
- the number of failed retry probes before the backend server is marked as being down
Acceptable values are from 1 second to 20.
-
host
String host()Gets host name to send the probe to.- Returns:
- host name to send the probe to
-
isHostNameFromBackendHttpSettings
Boolean isHostNameFromBackendHttpSettings()Checks whether probe uses the host name from the HTTP settings to which this probe is associated.- Returns:
- Whether probe uses the host name from the HTTP settings.
-