Edit

Set-AzApplicationGatewayBackendSetting

  • Reference
Module:
Az.Network

Updates back-end TCP\TLS settings for an application gateway.

Syntax

Set-AzApplicationGatewayBackendSetting
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -Port <Int32>
   -Protocol <String>
   [-Timeout <Int32>]
   [-ProbeId <String>]
   [-Probe <PSApplicationGatewayProbe>]
   [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
   [-PickHostNameFromBackendAddress]
   [-HostName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzApplicationGatewayBackendSetting cmdlet updates the back-end TCP\TLS settings for an Azure application gateway. Back-end settings are applied to all back-end servers in a pool.

Examples

Example 1: Update the back-end TCP\TLS settings for an application gateway

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayBackendSetting -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "Tcp"

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 Backend settings of the application gateway in the $AppGw variable to use port 88, the TCP protocol.

Parameters

-ApplicationGateway

The applicationGateway

Type:PSApplicationGateway
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

The name of the backend settings

Type:String
Position:Named
Default value:None
Required:True
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

Port

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

-Probe

Application gateway Probe

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

-ProbeId

ID of the application gateway Probe

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

-Protocol

Protocol

Type:String
Accepted values:TCP, TLS
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Timeout

Timeout. Default value 30 seconds.

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