< Back
Add-AzureRmApplicationGatewayProbeConfig
Post
NAME Add-AzureRmApplicationGatewayProbeConfig
SYNOPSIS
Adds a health probe to an Application Gateway.
SYNTAX
Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [-HostName
<String>] -Interval <Int32> [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-MinServers <Int32>] -Name <String> -Path <String>
[-PickHostNameFromBackendHttpSettings] -Protocol {Http | Https} -Timeout <Int32> -UnhealthyThreshold <Int32> [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway.
PARAMETERS
-ApplicationGateway <PSApplicationGateway>
Specifies the application gateway to which this cmdlet adds a probe.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HostName <String>
Specifies the host name that this cmdlet sends the probe to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Interval <Int32>
Specifies the probe interval in seconds. This is the time interval between two consecutive probes. This value is between 1 second and 86400
seconds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Match <PSApplicationGatewayProbeHealthResponseMatch>
Body that must be contained in the health response. Default value is empty
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MinServers <Int32>
Minimum number of servers that are always marked healthy. Default value is 0
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the probe.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the relative path of probe. Valid path start with the slash character (/). The probe is sent to <Protocol>://<host>:<port><path>.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PickHostNameFromBackendHttpSettings [<SwitchParameter>]
Whether the host header should be picked from the backend http settings. Default value is false
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol used to send probe. This cmdlet supports HTTP only.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Timeout <Int32>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UnhealthyThreshold <Int32>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSApplicationGateway
Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... robeconfig
Add a probe to an existing application gateway
https://azure.microsoft.com/en-us/docum ... on-gateway
Get-AzureRmApplicationGatewayProbeConfig
New-AzureRmApplicationGatewayProbeConfig
Remove-AzureRmApplicationGatewayProbeConfig
Set-AzureRmApplicationGatewayProbeConfig
SYNOPSIS
Adds a health probe to an Application Gateway.
SYNTAX
Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [-HostName
<String>] -Interval <Int32> [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-MinServers <Int32>] -Name <String> -Path <String>
[-PickHostNameFromBackendHttpSettings] -Protocol {Http | Https} -Timeout <Int32> -UnhealthyThreshold <Int32> [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway.
PARAMETERS
-ApplicationGateway <PSApplicationGateway>
Specifies the application gateway to which this cmdlet adds a probe.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HostName <String>
Specifies the host name that this cmdlet sends the probe to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Interval <Int32>
Specifies the probe interval in seconds. This is the time interval between two consecutive probes. This value is between 1 second and 86400
seconds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Match <PSApplicationGatewayProbeHealthResponseMatch>
Body that must be contained in the health response. Default value is empty
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MinServers <Int32>
Minimum number of servers that are always marked healthy. Default value is 0
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the probe.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the relative path of probe. Valid path start with the slash character (/). The probe is sent to <Protocol>://<host>:<port><path>.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PickHostNameFromBackendHttpSettings [<SwitchParameter>]
Whether the host header should be picked from the backend http settings. Default value is false
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol used to send probe. This cmdlet supports HTTP only.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Timeout <Int32>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UnhealthyThreshold <Int32>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSApplicationGateway
Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... robeconfig
Add a probe to an existing application gateway
https://azure.microsoft.com/en-us/docum ... on-gateway
Get-AzureRmApplicationGatewayProbeConfig
New-AzureRmApplicationGatewayProbeConfig
Remove-AzureRmApplicationGatewayProbeConfig
Set-AzureRmApplicationGatewayProbeConfig