Get-AzLoadBalancerBackendAddressPool

  • Reference
Module:
Az.Network

Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer.

Syntax

Get-AzLoadBalancerBackendAddressPool
   -ResourceGroupName <String>
   -LoadBalancerName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzLoadBalancerBackendAddressPool
   [-Name <String>]
   -LoadBalancer <PSLoadBalancer>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzLoadBalancerBackendAddressPool
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer.

Examples

Example 1

## Get single backend under loadbalancer
$lb = Get-AzLoadBalancer -ResourceGroupName $resourceGroup -Name $loadBalancerName

## Get all backends under loadbalancer
$lb | Get-AzLoadBalancerBackendAddressPool

Example 2

#Get specific backend from loadbalancer
$lb | Get-AzLoadBalancerBackendAddressPool -Name $backendPool1

Example 3

#Get a backend by resource Id
Get-AzLoadBalancerBackendAddressPool -ResourceId $backendPool1.Id

Parameters

-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

-LoadBalancer

{{ Fill LoadBalancer Description }}

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

-LoadBalancerName

The name of the load balancer.

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

-Name

The name of the backend address pool.

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

-ResourceGroupName

The resource group name of the load balancer.

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

-ResourceId

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

Inputs

PSLoadBalancer

String

Outputs

PSBackendAddressPool