Remove-AzLoadBalancerBackendAddressPool

Module:

Az.Network Module

Removes a backend pool from a load balancer

Syntax

DeleteByNameParameterSet (Default)

Remove-AzLoadBalancerBackendAddressPool
    -ResourceGroupName <String>
    -Name <String>
    [-LoadBalancerName <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByParentObjectParameterSet

Remove-AzLoadBalancerBackendAddressPool
    -Name <String>
    -LoadBalancer <PSLoadBalancer>
    [-LoadBalancerName <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByInputObjectParameterSet

Remove-AzLoadBalancerBackendAddressPool
    -InputObject <PSBackendAddressPool>
    [-LoadBalancerName <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByResourceIdParameterSet

Remove-AzLoadBalancerBackendAddressPool
    -ResourceId <String>
    [-LoadBalancerName <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Removes a backend pool from a load balancer

Examples

Example 1

##removing by passing lb object via pipeline
$lb | Remove-AzLoadBalancerBackendAddressPool -Name $backendPool1

Example 2

##removing by passing input object
Remove-AzLoadBalancerBackendAddressPool -InputObject $backendPoolObject

Example 3

##removing by passing input object
Remove-AzLoadBalancerBackendAddressPool -ResourceId $backendPoolObject.Id

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The backend address pool to remove

Parameter properties

Type:	PSBackendAddressPool
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DeleteByInputObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LoadBalancer

The load balancer resource.

Parameter properties

Type:	PSLoadBalancer
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DeleteByParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LoadBalancerName

The name of the load balancer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name of the load balancer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DeleteByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

DeleteByParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

{{ Fill PassThru Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The resource group name of the load balancer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DeleteByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

Removes a backend pool from a load balancer

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DeleteByResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSLoadBalancer

String

Outputs

PSBackendAddressPool