New-AzureRmApplicationGatewayRedirectConfiguration
Creates a redirect configuration for an 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
New-AzureRmApplicationGatewayRedirectConfiguration
-Name <String>
-RedirectType <String>
[-TargetListenerID <String>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzureRmApplicationGatewayRedirectConfiguration
-Name <String>
-RedirectType <String>
[-TargetListener <PSApplicationGatewayHttpListener>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzureRmApplicationGatewayRedirectConfiguration
-Name <String>
-RedirectType <String>
[-TargetUrl <String>]
[-IncludePath <Boolean>]
[-IncludeQueryString <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzureRmApplicationGatewayRedirectConfiguration cmdlet creates a redirect configuration for an application gateway.
Examples
Example 1
PS C:\>$RedirectConfig = New-AzureRmApplicationGatewayRedirectConfiguration -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01This command creates a redirect configuration named Redirect01 and stores the result in the variable named $RedirectConfig.
Parameters
-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
None