Set-AzApplicationGatewayRedirectConfiguration

Sets the redirect configuration on an existing Application Gateway.

Syntax

Set-AzApplicationGatewayRedirectConfiguration
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -RedirectType <String>
   [-TargetListenerID <String>]
   [-IncludePath <Boolean>]
   [-IncludeQueryString <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApplicationGatewayRedirectConfiguration
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -RedirectType <String>
   [-TargetListener <PSApplicationGatewayHttpListener>]
   [-IncludePath <Boolean>]
   [-IncludeQueryString <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApplicationGatewayRedirectConfiguration
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -RedirectType <String>
   [-TargetUrl <String>]
   [-IncludePath <Boolean>]
   [-IncludeQueryString <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzApplicationGatewayRequestRoutingRule cmdlet modifies a redirect configuration.

Examples

Example 1

PS C:\>$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\> $AppGw =  Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway $appgw -Name "RedirectConfig01" -RedirectType Permanent -TargetUrl "https://www.contoso.com"

The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. The second command modifies the redirect configuration for the application gateway to redirect type Permanent and use a target url.

Parameters

-ApplicationGateway

The applicationGateway

Type:PSApplicationGateway
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
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
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludePath

Include path in the redirected url. Default is true.

Type:System.Nullable`1[System.Boolean]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludeQueryString

Include query string in the redirected url. Default is true.

Type:System.Nullable`1[System.Boolean]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

The name of the Redirect Configuration

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RedirectType

The type of redirect

Type:String
Accepted values:Permanent, Found, SeeOther, Temporary
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TargetListener

HTTP listener to redirect the request to

Type:PSApplicationGatewayHttpListener
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TargetListenerID

ID of HTTP listener to redirect the request to

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TargetUrl

Target URL fo redirection

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

Inputs

PSApplicationGateway

Outputs

PSApplicationGateway