Edit

Share via


Add-AzApplicationGatewayHttpListenerCustomError

Adds a custom error to a http listener of an application gateway.

Syntax

Default (Default)

Add-AzApplicationGatewayHttpListenerCustomError
    -HttpListener <PSApplicationGatewayHttpListener>
    -StatusCode <String>
    -CustomErrorPageUrl <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Add-AzApplicationGatewayCustomError cmdlet adds a custom error to a http listener of an application gateway.

Examples

Example 1: Adds custom error to http listener level

$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm"
$updatedlistener = Add-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url

This command adds a custom error of http status code 502 to the http listener $listener01, and return the updated listener.

Parameters

-CustomErrorPageUrl

Error page URL of the application gateway customer error.

Parameter properties

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

Parameter sets

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

-HttpListener

The Application Gateway Http Listener

Parameter properties

Type:PSApplicationGatewayHttpListener
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

-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:True
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

PSApplicationGatewayHttpListener

Outputs

PSApplicationGatewayCustomError