Edit

Set-AzApplicationGatewayBackendHttpSetting

  • Reference
Module:
Az.Network

Updates back-end HTTP settings for an application gateway.

Syntax

Set-AzApplicationGatewayBackendHttpSetting
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -Port <Int32>
   -Protocol <String>
   -CookieBasedAffinity <String>
   [-RequestTimeout <Int32>]
   [-ConnectionDraining <PSApplicationGatewayConnectionDraining>]
   [-ProbeId <String>]
   [-Probe <PSApplicationGatewayProbe>]
   [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
   [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
   [-PickHostNameFromBackendAddress]
   [-HostName <String>]
   [-AffinityCookieName <String>]
   [-Path <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzApplicationGatewayBackendHttpSetting 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

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayBackendHttpSetting -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.

Example 2

Updates back-end HTTP settings for an application gateway. (autogenerated)

Set-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -CookieBasedAffinity Enabled -Name 'Setting02' -Port 88 -Probe <PSApplicationGatewayProbe> -Protocol https -RequestTimeout <Int32>

Parameters

-AffinityCookieName

Cookie name to use for the affinity cookie

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

-ApplicationGateway

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

Type:PSApplicationGateway
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AuthenticationCertificates

Specifies authentication certificates for the application gateway.

Type:PSApplicationGatewayAuthenticationCertificate[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionDraining

Connection draining of the backend http settings resource.

Type:PSApplicationGatewayConnectionDraining
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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
Accepted values:Enabled, Disabled
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostName

Sets host header to be sent to the backend servers.

Type:String
Position:Named
Default value:None
Required:False
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
Required:True
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
Required:False
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
Required:False
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
Required:True
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
Required:False
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
Required:False
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
Accepted values:Http, Https
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RequestTimeout

Specifies a request time-out value.

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

-TrustedRootCertificate

Application gateway Trusted Root Certificates

Type:PSApplicationGatewayTrustedRootCertificate[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSApplicationGateway

Outputs

PSApplicationGateway