Add-​Azure​Rm​Application​Gateway​Probe​Config

Adds a health probe to an Application Gateway.

Syntax

Add-AzureRmApplicationGatewayProbeConfig
   -ApplicationGateway <PSApplicationGateway>
   [-HostName <String>]
   -Interval <UInt32>
   [-Match <PSApplicationGatewayProbeHealthResponseMatch>]
   [-MinServers <UInt32>]
   -Name <String>
   -Path <String>
   [-PickHostNameFromBackendHttpSettings]
   -Protocol <String>
   -Timeout <UInt32>
   -UnhealthyThreshold <UInt32>
   [<CommonParameters>]

Description

The Add-AzureRmApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway.

Examples

Example 1: Add a health probe to an application gateway

PS C:\>$Probe = Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe01" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8

This command adds a health probe named Probe01 for the application gateway named Gateway. The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds.

Required Parameters

-ApplicationGateway

Specifies the application gateway to which this cmdlet adds a probe.

Type:PSApplicationGateway
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Interval

Specifies the probe interval in seconds. This is the time interval between two consecutive probes. This value is between 1 second and 86400 seconds.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the probe.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the relative path of probe. Valid path start with the slash character (/). The probe is sent to <Protocol>://<host>:<port><path>.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Protocol

Specifies the protocol used to send probe. This cmdlet supports HTTP only.

Type:String
Parameter Sets:Http, Https
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Timeout

Specifies the probe timeout in seconds. This cmdlet marks the probe as failed if a valid response is not received with this timeout period. Valid values are between 1 second and 86400 seconds.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UnhealthyThreshold

Specifies the probe retry count. The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. Valid values are between 1 second and 20 seconds.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-HostName

Specifies the host name that this cmdlet sends the probe to.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Match

Body that must be contained in the health response. Default value is empty

Type:PSApplicationGatewayProbeHealthResponseMatch
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinServers

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

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PickHostNameFromBackendHttpSettings

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False