< Back
Add-AzureRmApplicationGatewayBackendHttpSettings
Post
NAME Add-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Adds back-end HTTP settings to an application gateway.
SYNTAX
Add-AzureRmApplicationGatewayBackendHttpSettings [-AffinityCookieName <String>] -ApplicationGateway <PSApplicationGateway>
[-AuthenticationCertificates
<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] [-ConnectionDraining
<PSApplicationGatewayConnectionDraining>] -CookieBasedAffinity {Enabled | Disabled} [-DefaultProfile <IAzureContextContainer>] [-HostName
<String>] -Name <String> [-Path <String>] [-PickHostNameFromBackendAddress] -Port <Int32> [-Probe <PSApplicationGatewayProbe>] [-ProbeEnabled]
[-ProbeId <String>] -Protocol {Http | Https} [-RequestTimeout <Int32>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApplicationGatewayBackendHttpSettings cmdlet adds back-end HTTP settings to an application gateway.
Back-end HTTP settings are applied to all back-end servers in the pool.
PARAMETERS
-AffinityCookieName <String>
Cookie name to use for the affinity cookie
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ApplicationGateway <PSApplicationGateway>
Specifies the name of application gateway for which this cmdlet adds settings.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-AuthenticationCertificates
<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>
Specifies authentication certificates for the application gateway.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConnectionDraining <PSApplicationGatewayConnectionDraining>
Connection draining of the backend http settings resource.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CookieBasedAffinity <String>
Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. The acceptable values for this parameter
are: Disabled, Enabled.
Required? true
Position? named
Default value None
Accept pipeline input? False
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>
Sets host header to be sent to the backend servers.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the back-end HTTP settings which this cmdlet adds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Path which should be used as a prefix for all HTTP requests. If no value is provided for this parameter, then no path will be prefixed.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PickHostNameFromBackendAddress [<SwitchParameter>]
Flag if host header should be picked from the host name of the backend server.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Port <Int32>
Specifies the port of the back-end server pool.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Probe <PSApplicationGatewayProbe>
Specifies a probe to associate with a back-end server.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProbeEnabled [<SwitchParameter>]
Flag if probe should be enabled.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ProbeId <String>
Specifies the ID of the probe to associate with the back-end server.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol for communication between application gateway and back-end servers. The acceptable values for this parameter are: Http
and Https.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RequestTimeout <Int32>
Specifies the request time-out value.
Required? false
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
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
Example 1: Add back-end HTTP settings to an application gateway
PS C:\\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "HTTP"
-CookieBasedAffinity "Disabled"
The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it
in the $AppGw variable.The second command adds back-end HTTP settings to the application gateway, setting the port to 88 and the protocol to HTTP
and names the settings Setting02.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Get-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings
Set-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Adds back-end HTTP settings to an application gateway.
SYNTAX
Add-AzureRmApplicationGatewayBackendHttpSettings [-AffinityCookieName <String>] -ApplicationGateway <PSApplicationGateway>
[-AuthenticationCertificates
<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] [-ConnectionDraining
<PSApplicationGatewayConnectionDraining>] -CookieBasedAffinity {Enabled | Disabled} [-DefaultProfile <IAzureContextContainer>] [-HostName
<String>] -Name <String> [-Path <String>] [-PickHostNameFromBackendAddress] -Port <Int32> [-Probe <PSApplicationGatewayProbe>] [-ProbeEnabled]
[-ProbeId <String>] -Protocol {Http | Https} [-RequestTimeout <Int32>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmApplicationGatewayBackendHttpSettings cmdlet adds back-end HTTP settings to an application gateway.
Back-end HTTP settings are applied to all back-end servers in the pool.
PARAMETERS
-AffinityCookieName <String>
Cookie name to use for the affinity cookie
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ApplicationGateway <PSApplicationGateway>
Specifies the name of application gateway for which this cmdlet adds settings.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-AuthenticationCertificates
<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>
Specifies authentication certificates for the application gateway.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConnectionDraining <PSApplicationGatewayConnectionDraining>
Connection draining of the backend http settings resource.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CookieBasedAffinity <String>
Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. The acceptable values for this parameter
are: Disabled, Enabled.
Required? true
Position? named
Default value None
Accept pipeline input? False
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>
Sets host header to be sent to the backend servers.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the back-end HTTP settings which this cmdlet adds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Path which should be used as a prefix for all HTTP requests. If no value is provided for this parameter, then no path will be prefixed.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PickHostNameFromBackendAddress [<SwitchParameter>]
Flag if host header should be picked from the host name of the backend server.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Port <Int32>
Specifies the port of the back-end server pool.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Probe <PSApplicationGatewayProbe>
Specifies a probe to associate with a back-end server.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProbeEnabled [<SwitchParameter>]
Flag if probe should be enabled.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ProbeId <String>
Specifies the ID of the probe to associate with the back-end server.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol for communication between application gateway and back-end servers. The acceptable values for this parameter are: Http
and Https.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RequestTimeout <Int32>
Specifies the request time-out value.
Required? false
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
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
Example 1: Add back-end HTTP settings to an application gateway
PS C:\\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "HTTP"
-CookieBasedAffinity "Disabled"
The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it
in the $AppGw variable.The second command adds back-end HTTP settings to the application gateway, setting the port to 88 and the protocol to HTTP
and names the settings Setting02.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Get-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings
Set-AzureRmApplicationGatewayBackendHttpSettings