Edit

Share via


Get-AzApplicationGatewayCustomError

Gets custom error(s) from an application gateway.

Syntax

Default (Default)

Get-AzApplicationGatewayCustomError
    [-StatusCode <String>]
    -ApplicationGateway <PSApplicationGateway>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzApplicationGatewayCustomError cmdlet gets custom error(s) from an application gateway.

Examples

Example 1: Gets a custom error in an application gateway

$ce = Get-AzApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502

This command gets and returns the custom error of http status code 502 from the application gateway $appgw.

Example 2: Gets the list of all custom errors in an application gateway

$ces = Get-AzApplicationGatewayCustomError -ApplicationGateway $appgw

This command gets and returns the list of all custom errors from the application gateway $appgw.

Parameters

-ApplicationGateway

The 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

-StatusCode

Status code of the application gateway customer error.

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

PSApplicationGatewayCustomError