< Back
New-AzureRmApplicationGatewayBackendHttpSettings
Post
NAME New-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Creates back-end HTTP settings for an application gateway.
SYNTAX
New-AzureRmApplicationGatewayBackendHttpSettings [-AffinityCookieName <String>] [-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 New-AzureRmApplicationGatewayBackendHttpSettings cmdlet creates back-end HTTP settings for an 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
-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 back-end server pool.
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 that this cmdlet creates.
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 the back-end server pool.
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 pool.
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 the 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 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.PSApplicationGatewayBackendHttpSettings
NOTES
Example 1: Create back-end HTTP settings
PS C:\\>$Setting = New-AzureRmApplicationGatewayBackendHttpSettings -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Add-AzureRmApplicationGatewayBackendHttpSettings
Get-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings
Set-AzureRmApplicationGatewayBackendHttpSettings
SYNOPSIS
Creates back-end HTTP settings for an application gateway.
SYNTAX
New-AzureRmApplicationGatewayBackendHttpSettings [-AffinityCookieName <String>] [-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 New-AzureRmApplicationGatewayBackendHttpSettings cmdlet creates back-end HTTP settings for an 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
-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 back-end server pool.
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 that this cmdlet creates.
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 the back-end server pool.
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 pool.
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 the 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 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.PSApplicationGatewayBackendHttpSettings
NOTES
Example 1: Create back-end HTTP settings
PS C:\\>$Setting = New-AzureRmApplicationGatewayBackendHttpSettings -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tpsettings
Add-AzureRmApplicationGatewayBackendHttpSettings
Get-AzureRmApplicationGatewayBackendHttpSettings
Remove-AzureRmApplicationGatewayBackendHttpSettings
Set-AzureRmApplicationGatewayBackendHttpSettings