< Back
Set-AzureRmApplicationGatewayBackendHttpSettings
Post
NAME Set-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Updates back-end HTTP settings for an application gateway.
SYNTAX
Set-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 Set-AzureRmApplicationGatewayBackendHttpSettings cmdlet updates the back-end Hypertext Transfer Protocol (HTTP) settings for an Azure
application gateway. Back-end HTTP settings are applied to all back-end servers in a 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 an application gateway object with which this cmdlet associates back-end HTTP 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 or 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 object.
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 to use for each server in 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 the back-end HTTP settings.
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 HTTP settings.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol to use for communication between the application gateway and back-end servers. The acceptable values for this parameter
are: Http and Https. This parameter is case-sensitive.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RequestTimeout <Int32>
Specifies a 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: Update the back-end HTTP settings for an application gateway
PS C:\\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-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 updates the HTTP settings of the application gateway in the $AppGw variable to use port 88, the HTTP protocol and enables
cookie-based affinity.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Add-AzureRmApplicationGatewayBackendHttpSettings
Get-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Updates back-end HTTP settings for an application gateway.
SYNTAX
Set-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 Set-AzureRmApplicationGatewayBackendHttpSettings cmdlet updates the back-end Hypertext Transfer Protocol (HTTP) settings for an Azure
application gateway. Back-end HTTP settings are applied to all back-end servers in a 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 an application gateway object with which this cmdlet associates back-end HTTP 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 or 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 object.
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 to use for each server in 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 the back-end HTTP settings.
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 HTTP settings.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol to use for communication between the application gateway and back-end servers. The acceptable values for this parameter
are: Http and Https. This parameter is case-sensitive.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RequestTimeout <Int32>
Specifies a 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: Update the back-end HTTP settings for an application gateway
PS C:\\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-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 updates the HTTP settings of the application gateway in the $AppGw variable to use port 88, the HTTP protocol and enables
cookie-based affinity.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Add-AzureRmApplicationGatewayBackendHttpSettings
Get-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings