Interface ApplicationGatewayProbe

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource<ApplicationGateway>, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<ApplicationGatewayProbeInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent<ApplicationGateway>, HasProtocol<ApplicationGatewayProtocol>, com.azure.resourcemanager.resources.fluentcore.model.Indexable
public interface ApplicationGatewayProbe extends com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<ApplicationGatewayProbeInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource<ApplicationGateway>, HasProtocol<ApplicationGatewayProtocol>
A client-side representation of an application gateway probe.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ApplicationGatewayProbe.Definition<ParentT>
    The entirety of an application gateway probe definition.
    static interface 
    ApplicationGatewayProbe.DefinitionStages
    Grouping of application gateway probe definition stages.
    static interface 
    ApplicationGatewayProbe.Update
    The entirety of an application gateway probe update as part of an application gateway update.
    static interface 
    ApplicationGatewayProbe.UpdateDefinition<ParentT>
    The entirety of an application gateway probe definition as part of an application gateway update.
    static interface 
    ApplicationGatewayProbe.UpdateDefinitionStages
    Grouping of application gateway probe definition stages applicable as part of an application gateway update.
    static interface 
    ApplicationGatewayProbe.UpdateStages
    Grouping of application gateway probe update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    Set<String>
    healthyHttpResponseStatusCodeRanges()
    Gets HTTP response code ranges in the format ###-### returned by the backend which the probe considers healthy.
    String
    host()
    Gets host name to send the probe to.
    Boolean
    isHostNameFromBackendHttpSettings()
    Checks whether probe uses the host name from the HTTP settings to which this probe is associated.
    String
    path()
    Gets the relative path to be called by the probe.
    int
    retriesBeforeUnhealthy()
    Gets the number of failed retry probes before the backend server is marked as being down.
    int
    timeBetweenProbesInSeconds()
    Gets the number of seconds between probe retries.
    int
    timeoutInSeconds()
    Gets 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

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent

    parent

    Methods inherited from interface HasProtocol

    protocol

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

  • Method Details

    • timeBetweenProbesInSeconds

      int timeBetweenProbesInSeconds()
      Gets the number of seconds between probe retries.
      Returns:
      the number of seconds between probe retries

    • healthyHttpResponseStatusCodeRanges

      Set<String> 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.