Edit

Share via


Get-AzApplicationGatewayBackendAddressPool

Gets a back-end address pool for an application gateway.

Syntax

Default (Default)

Get-AzApplicationGatewayBackendAddressPool
    [-Name <String>]
    -ApplicationGateway <PSApplicationGateway>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzApplicationGatewayBackendAddressPool cmdlet gets one or more backend address pool configurations from an application gateway.

Examples

Example 1: Get a specified back-end server pool

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$BackendPool = Get-AzApplicationGatewayBackendAddressPool -Name "Pool01" -ApplicationGateway $AppGw

The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the back-end address pool associated with $AppGw named Pool01 and stores it in the $BackendPool variable.

Example 2: Get a list of back-end server pool

$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$BackendPools = Get-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw

The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets a list of the back-end address pools associated with $AppGw, and stores the list in the $BackendPools variable.

Parameters

-ApplicationGateway

The Get-AzApplicationGatewayBackendAddressPool cmdlet gets a back-end address pool for an application gateway.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
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

-Name

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

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

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

PSApplicationGateway

Outputs

PSApplicationGatewayBackendAddressPool