Edit

Share via

Remove-AzureRmLoadBalancerBackendAddressPoolConfig

  • Reference
Module:
AzureRM.Network

Removes a backend address pool configuration from a load balancer.

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

Remove-AzureRmLoadBalancerBackendAddressPoolConfig
      -LoadBalancer <PSLoadBalancer>
      [-Name <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureRmLoadBalancerBackendAddressPoolConfig cmdlet removes a backend address pool from a load balancer.

Examples

Example 1: Remove a backend address pool configuration from a load balancer

PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" | Remove-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzureRmLoadBalancer

This command gets the load balancer named MyLoadBalancer and passes it to Remove-AzureRmLoadBalancerBackendAddressPoolConfig, which removes the BackendAddressPool02 configuration from MyLoadBalancer. Finally, the Set-AzureRmLoadBalancer cmdlet updates MyLoadBalancer. Note that a backend address pool configuration must exist before you can delete it.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-LoadBalancer

Specifies the load balancer that contains the backend address pool to remove.

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

-Name

Specifies the name of the backend address pool that this cmdlet removes.

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

Inputs

PSLoadBalancer

Parameters: LoadBalancer (ByValue)

Outputs

PSLoadBalancer