Set-AzureRmApplicationGatewayConnectionDraining

  • Reference
Module:
AzureRM.Network

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

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1

PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\> $Settings  = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw
PS C:\> Set-AzureRmApplicationGatewayConnectionDraining -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: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

Parameters: BackendHttpSettings (ByValue)

Outputs

PSApplicationGatewayBackendHttpSettings