Set-AzApplicationGatewayHttpListenerCustomError.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml	Az.Network	https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayhttplistenercustomerror	2.0.0

Set-AzApplicationGatewayHttpListenerCustomError

SYNOPSIS

Updates a custom error in a http listener of an application gateway.

SYNTAX

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

DESCRIPTION

The Set-AzApplicationGatewayHttpListenerCustomError cmdlet updates a custom error in a http listener of an application gateway.

EXAMPLES

Example 1: Updates a custom error from a http listener

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

This command updates the custom error of http status code 502 in the http listener $listener01, and returns the updated listener.

PARAMETERS

-CustomErrorPageUrl

Error page URL of the application gateway customer error.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-HttpListener

The Application Gateway Http Listener

Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-StatusCode

Status code of the application gateway customer error.

Type: System.String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError

NOTES

RELATED LINKS

Add-AzApplicationGatewayHttpListenerCustomError

Get-AzApplicationGatewayHttpListenerCustomError

Remove-AzApplicationGatewayHttpListenerCustomError