Edit

Set-AzApplicationGatewayConnectionDraining

  • Reference
Module:
Az.Network

Modifies the connection draining configuration of a back-end HTTP settings object.

Syntax

Set-AzApplicationGatewayConnectionDraining
   -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
   -Enabled <Boolean>
   -DrainTimeoutInSec <Int32>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzApplicationGatewayConnectionDraining cmdlet modifies the connection draining configuration of a back-end HTTP settings object.

Examples

Example 1

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$Settings  = Get-AzApplicationGatewayBackendHttpSetting -Name "Settings01" -ApplicationGateway $AppGw
Set-AzApplicationGatewayConnectionDraining -BackendHttpSettings $poolSetting02 -Enabled $False -DrainTimeoutInSec 3600

The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. The last command modifies the connection draining configuration of the back-end HTTP settings object stored in $Settings by setting Enabled to False and DrainTimeoutInSec to 3600.

Parameters

-BackendHttpSettings

The backend http settings

Type:PSApplicationGatewayBackendHttpSettings
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

-DrainTimeoutInSec

The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

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

-Enabled

Whether connection draining is enabled or not.

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

Inputs

PSApplicationGatewayBackendHttpSettings

Outputs

PSApplicationGatewayBackendHttpSettings