ApplicationGatewayProbe Class

Definition

Probe of the application gateway.

public class ApplicationGatewayProbe : Azure.Provisioning.Primitives.ProvisionableConstruct
type ApplicationGatewayProbe = class
    inherit ProvisionableConstruct
Public Class ApplicationGatewayProbe
Inherits ProvisionableConstruct
Inheritance
ApplicationGatewayProbe

Constructors

Name Description
ApplicationGatewayProbe()

Creates a new ApplicationGatewayProbe.

Properties

Name Description
ETag

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

Host

Host name to send the probe to.

Id

Resource ID.

IntervalInSeconds

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

IsProbeProxyProtocolHeaderEnabled

Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false.

Match

Criterion for classifying a healthy probe response.

MinServers

Minimum number of servers that are always marked healthy. Default value is 0.

Name

Resource name.

Path

Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.

PickHostNameFromBackendHttpSettings

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

PickHostNameFromBackendSettings

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

Port

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.

Protocol

The protocol used for the probe.

ProvisioningState

The provisioning state of the probe resource.

ResourceType

Resource type.

TimeoutInSeconds

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.

UnhealthyThreshold

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

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of ApplicationGatewayProbe.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableConstruct)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to