تحرير

New-AzApplicationGatewayBackendHttpSetting

  • Reference
Module:
Az.Network

Creates back-end HTTP setting for an application gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzApplicationGatewayBackendHttpSetting
   -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 New-AzApplicationGatewayBackendHttpSetting cmdlet creates back-end HTTP settings for an application gateway. Back-end HTTP settings are applied to all back-end servers in a pool.

Examples

Example 1: Create back-end HTTP settings

PS C:\>$Setting = New-AzApplicationGatewayBackendHttpSetting -Name "Setting01" -Port 80 -Protocol Http -CookieBasedAffinity Disabled

This command creates back-end HTTP settings named Setting01 on port 80, using the HTTP protocol, with cookie-based affinity disabled. The settings are stored in the $Setting variable.

Example 2

Creates back-end HTTP setting for an application gateway. (autogenerated)

New-AzApplicationGatewayBackendHttpSetting -CookieBasedAffinity Enabled -Name 'Setting01' -PickHostNameFromBackendAddress -Port 80 -Probe <PSApplicationGatewayProbe> -Protocol http -RequestTimeout <Int32>

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: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
-CookieBasedAffinity

Specifies whether cookie-based affinity should be enabled or disabled for the back-end server pool.

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

Specifies the name of the back-end HTTP settings that this cmdlet creates.

Type:String
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
-Port

Specifies the port of the back-end server pool.

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

Specifies a probe to associate with the back-end server pool.

Type:PSApplicationGatewayProbe
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 server pool.

Type:String
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 the back-end servers. The acceptable values for this parameter are: Http and Https.

Type:String
Accepted values:Http, Https
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RequestTimeout

Specifies a request time-out value.

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

Application gateway Trusted Root Certificates

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

Inputs

None

Outputs

PSApplicationGatewayBackendHttpSettings