Get-AzLoadBalancerBackendAddressPool
Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer.
Syntax
GetByNameParameterSet (Default)
Get-AzLoadBalancerBackendAddressPool
-ResourceGroupName <String>
-LoadBalancerName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByParentObjectParameterSet
Get-AzLoadBalancerBackendAddressPool
-LoadBalancer <PSLoadBalancer>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
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.
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
-LoadBalancer
{{ Fill LoadBalancer Description }}
Parameter properties
Type: PSLoadBalancer
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByParentObjectParameterSet
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
GetByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the backend address pool.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByParentObjectParameterSet
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
GetByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True 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 .
Outputs
