Edit

Share via

Add-AzApplicationGatewayHttpListenerCustomError

  • Reference
Module:
Az.Network

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

Syntax

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.

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

-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

-HttpListener

The Application Gateway Http Listener

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

-StatusCode

Status code of the application gateway customer error.

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

Inputs

PSApplicationGatewayHttpListener

Outputs

PSApplicationGatewayCustomError