Set-​Azure​Rm​Application​Gateway​Backend​Http​Settings

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 <String>
   -Name <String>
   [-Path <String>]
   [-PickHostNameFromBackendAddress]
   -Port <Int32>
   [-Probe <PSApplicationGatewayProbe>]
   [-ProbeEnabled]
   [-ProbeId <String>]
   -Protocol <String>
   [-RequestTimeout <UInt32>]
   [<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.

Examples

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.

Required Parameters

-ApplicationGateway

Specifies an application gateway object with which this cmdlet associates back-end HTTP settings.

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

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.

Type:String
Parameter Sets:Enabled, Disabled
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the back-end HTTP settings object.

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

Specifies the port to use for each server in the back-end server pool.

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

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.

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

Optional Parameters

-AffinityCookieName

Cookie name to use for the affinity cookie

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

Specifies authentication certificates for the application gateway.

Type:System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConnectionDraining

Connection draining of the backend http settings resource.

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

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.

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

Flag if host header should be picked from the host name of the backend server.

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

Specifies a probe to associate with the back-end HTTP settings.

Type:PSApplicationGatewayProbe
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbeEnabled

Flag if probe should be enabled.

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

Specifies the ID of the probe to associate with the back-end HTTP settings.

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

Specifies a request time-out value.

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

Inputs

System.String

Outputs

Microsoft.Azure.Commands.Network.Models.PSApplicationGateway