Edit

Share via


New-AzFrontDoorCdnRuleUrlRedirectActionObject

Create an in-memory object for UrlRedirectAction.

Syntax

Default (Default)

New-AzFrontDoorCdnRuleUrlRedirectActionObject
    -ParameterRedirectType <String>
    -ParameterTypeName <String>
    [-ParameterCustomFragment <String>]
    [-ParameterCustomHostname <String>]
    [-ParameterCustomPath <String>]
    [-ParameterCustomQueryString <String>]
    [-ParameterDestinationProtocol <String>]
    [<CommonParameters>]

Description

Create an in-memory object for UrlRedirectAction.

Examples

Example 1: Create an in-memory object for UrlRedirectAction

New-AzFrontDoorCdnRuleUrlRedirectActionObject -Name UrlRedirect -ParameterRedirectType Moved -ParameterDestinationProtocol MatchRequest
Name
----
UrlRedirect

Create an in-memory object for UrlRedirectAction

Parameters

-ParameterCustomFragment

Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterCustomHostname

Host to redirect. Leave empty to use the incoming host as the destination host.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterCustomPath

The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterCustomQueryString

The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. ? and & will be added automatically so do not include them.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterDestinationProtocol

Protocol to use for the redirect. The default value is MatchRequest.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterRedirectType

The redirect type the rule will use when redirecting traffic.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParameterTypeName

Create an in-memory object for UrlRedirectAction.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

UrlRedirectAction