Set-AzureRmApplicationGatewayRedirectConfiguration
Sets the redirect configuration on an existing Application Gateway.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmApplicationGatewayRedirectConfiguration
-ApplicationGateway <PSApplicationGateway>
-Name <String>
-RedirectType <String>
[-TargetListenerID <String>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmApplicationGatewayRedirectConfiguration
-ApplicationGateway <PSApplicationGateway>
-Name <String>
-RedirectType <String>
[-TargetListener <PSApplicationGatewayHttpListener>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzureRmApplicationGatewayRedirectConfiguration
-ApplicationGateway <PSApplicationGateway>
-Name <String>
-RedirectType <String>
[-TargetUrl <String>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzureRmApplicationGatewayRequestRoutingRule cmdlet modifies a redirect configuration.
Examples
Example 1
PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\> $AppGw = Set-AzureRmApplicationGatewayRedirectConfiguration -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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the Redirect Configuration
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetListener
HTTPListener to redirect the request to
| Type: | PSApplicationGatewayHttpListener |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetListenerID
ID of listener to redirect the request to
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetUrl
Target URL fo redirection
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Parameters: ApplicationGateway (ByValue)