Remove-AzApplicationGatewayBackendAddressPool

  • Reference
Module:
Az.Network

Removes a back-end address pool from an application gateway.

Syntax

Remove-AzApplicationGatewayBackendAddressPool
      -Name <String>
      -ApplicationGateway <PSApplicationGateway>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzApplicationGatewayBackendAddressPool cmdlet removes a back-end address pool from an Azure application gateway.

Examples

Example 1: Remove a back-end address pool from an application gateway

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
Remove-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "BackEndPool02"
Set-AzApplicationGateway -ApplicationGateway $AppGw

The first command gets the application gateway named ApplicationGateway01 belonging to the resource group named ResourceGroup01 and saves it in the $AppGw variable. The second command removes the back-end address pool named BackEndPool02 from the application gateway. Finally, the third command updates the application gateway.

Parameters

-ApplicationGateway

Specifies the application gateway from which this cmdlet removes a back-end address pool.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the back-end address pool that this cmdlet removes.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSApplicationGateway

Outputs

PSApplicationGatewayBackendAddressPool