New-AzFrontDoorRoutingRuleObject
Create a PSRoutingRuleObject for Front Door creation
Syntax
ByFieldsWithForwardingParameterSet (Default)
New-AzFrontDoorRoutingRuleObject
-ResourceGroupName <String>
-FrontDoorName <String>
-Name <String>
-FrontendEndpointName <String[]>
-BackendPoolName <String>
[-AcceptedProtocol <PSProtocol[]>]
[-PatternToMatch <String[]>]
[-CustomForwardingPath <String>]
[-ForwardingProtocol <String>]
[-EnableCaching <Boolean>]
[-QueryParameterStripDirective <String>]
[-DynamicCompression <PSEnabledState>]
[-EnabledState <PSEnabledState>]
[-RulesEngineName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByFieldsWithRedirectParameterSet
New-AzFrontDoorRoutingRuleObject
-ResourceGroupName <String>
-FrontDoorName <String>
-Name <String>
-FrontendEndpointName <String[]>
[-AcceptedProtocol <PSProtocol[]>]
[-PatternToMatch <String[]>]
[-RedirectType <String>]
[-RedirectProtocol <String>]
[-CustomHost <String>]
[-CustomPath <String>]
[-CustomFragment <String>]
[-CustomQueryString <String>]
[-EnabledState <PSEnabledState>]
[-RulesEngineName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Create a PSRoutingRuleObject for Front Door creation
Examples
Example 1: Create a PSRoutingRuleObject for Front Door creation with a forwarding rule
New-AzFrontDoorRoutingRuleObject -Name $routingRuleName -FrontDoorName $frontDoorName -ResourceGroupName $rgname -FrontendEndpointName "frontendEndpoint1" -BackendPoolName "backendPool1"
FrontendEndpointIds : {/subscriptions/{subid}/resourceGroups/{rgname}/pro
viders/Microsoft.Network/frontDoors/{frontdoorname}/FrontendEndpoints/frontendEndpoint1}
AcceptedProtocols : {Http, Https}
PatternsToMatch : {/*}
HealthProbeSettings :
RouteConfiguration : Microsoft.Azure.Commands.FrontDoor.Models.PSForwardingConfiguration
EnabledState : Enabled
ResourceState :
Id :
Name : {routingRuleName}
Type :
Example 2: Create a PSRoutingRuleObject for Front Door creation with a redirect rule
$customHost = "www.contoso.com"
$customPath = "/images/contoso.png"
$queryString = "field1=value1&field2=value2"
$destinationFragment = "section-header-2"
New-AzFrontDoorRoutingRuleObject -Name $routingRuleName -FrontDoorName $frontDoorName -ResourceGroupName $rgname -FrontendEndpointName "frontendEndpoint1" -CustomHost $customHost -CustomPath $customPath -CustomQueryString $queryString -CustomFragment $destinationFragment
FrontendEndpointIds : {/subscriptions/{subid}/resourceGroups/{rgname}/pro
viders/Microsoft.Network/frontDoors/{frontdoorname}/FrontendEndpoints/frontendEndpoint1}
AcceptedProtocols : {Http, Https}
PatternsToMatch : {/*}
HealthProbeSettings :
RouteConfiguration : Microsoft.Azure.Commands.FrontDoor.Models.PSRedirectConfiguration
EnabledState : Enabled
ResourceState :
Id :
Name : {routingRuleName}
Type :
Create a PSRoutingRuleObject for Front Door creation
Parameters
-AcceptedProtocol
Protocol schemes to match for this rule.
Default value is {Https, Http}
Parameter properties
Type: PSProtocol [ ]
Default value: None Accepted values: Http, Https 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
-BackendPoolName
Resource id of the BackendPool which this rule routes to
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomForwardingPath
The custom path used to rewrite resource paths matched by this rule.
Leave empty to use incoming path.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomFragment
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
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomHost
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
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomPath
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
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomQueryString
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. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DynamicCompression
Whether to enable dynamic compression for cached content when caching is enabled.
Default value is Enabled
Parameter properties
Type: PSEnabledState
Default value: None Accepted values: Enabled, Disabled Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableCaching
Whether to enable caching for this route.
Default value is false
Parameter properties
Type: Boolean
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnabledState
Whether to enable use of this rule.
Default value is Enabled
Parameter properties
Type: PSEnabledState
Default value: None Accepted values: Enabled, Disabled 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
-ForwardingProtocol
The protocol this rule will use when forwarding traffic to backends
Default value is MatchRequest.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FrontDoorName
The name of the Front Door to which this routing rule belongs.
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
-FrontendEndpointName
The names of Frontend endpoints associated with this rule
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
-Name
RoutingRule name.
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
-PatternToMatch
The route patterns of the rule, Must not have any * except possibly after the final / at the end of the path.
Default value is /*
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
-QueryParameterStripDirective
The treatment of URL query terms when forming the cache key.
Default value is StripAll
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithForwardingParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RedirectProtocol
The protocol of the destination to where the traffic is redirected. Default value is MatchRequest
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RedirectType
The redirect type the rule will use when redirecting traffic. Default Value is Moved
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsWithRedirectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name that the RoutingRule will be created in.
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
-RulesEngineName
A reference to a specific Rules Engine Configuration to apply to this route.
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
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 .
None
Outputs
