Add-AzApplicationGatewayRedirectConfiguration

Reference

Module:: Az.Network

Adds a redirect configuration to an Application Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Add-AzApplicationGatewayRedirectConfiguration
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -RedirectType <String>
   [-TargetListenerID <String>]
   [-IncludePath <Boolean>]
   [-IncludeQueryString <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Add-AzApplicationGatewayRedirectConfiguration
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -RedirectType <String>
   [-TargetUrl <String>]
   [-IncludePath <Boolean>]
   [-IncludeQueryString <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Add-AzApplicationGatewayRedirectConfiguration cmdlet adds a redirect configuration to an Application Gateway.

Examples

Example 1

PS C:\>$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\>$Appgw = Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01

The first command gets the application gateway and stores it in the $AppGw variable. The second command adds the redirect configuration to the application gateway.

Example 2

Adds a redirect configuration to an Application Gateway. (autogenerated)

Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -IncludePath $false -IncludeQueryString $false -Name 'Redirect01' -RedirectType Permanent -TargetListener <PSApplicationGatewayHttpListener>

Parameters

-ApplicationGateway

The applicationGateway

Type:	PSApplicationGateway
Position:	Named
Default value:	None
Accept pipeline input:	True
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
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludePath

Include path in the redirected url. Default is true.

Type:	Nullable<T>[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:	Nullable<T>[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