New-AzFrontDoorRoutingRuleObject
Create an in-memory object for RoutingRule.
Syntax
ByFieldsWithForwardingParameterSet (Default)
New-AzFrontDoorRoutingRuleObject
[-AcceptedProtocol <String[]>]
[-EnabledState <String>]
[-FrontendEndpointName <String[]>]
[-Name <String>]
[-ResourceGroupName <String>]
[-FrontDoorName <String>]
[-PatternsToMatch <String[]>]
[-RouteConfiguration <IRouteConfiguration>]
[-RuleEngineName <String>]
[-WebApplicationFirewallPolicyLinkId <String>]
[-Id <String>]
[-BackendPoolName <String>]
[-CacheDuration <TimeSpan>]
[-DynamicCompression <String>]
[-QueryParameter <String>]
[-QueryParameterStripDirective <String>]
[-CustomForwardingPath <String>]
[-ForwardingProtocol <String>]
[-EnableCaching <Boolean>]
[<CommonParameters>]
ByFieldsWithRedirectParameterSet
New-AzFrontDoorRoutingRuleObject
[-AcceptedProtocol <String[]>]
[-EnabledState <String>]
[-FrontendEndpointName <String[]>]
[-Name <String>]
[-ResourceGroupName <String>]
[-FrontDoorName <String>]
[-PatternsToMatch <String[]>]
[-RouteConfiguration <IRouteConfiguration>]
[-RuleEngineName <String>]
[-WebApplicationFirewallPolicyLinkId <String>]
[-Id <String>]
[-CustomFragment <String>]
[-CustomHost <String>]
[-CustomPath <String>]
[-CustomQueryString <String>]
[-RedirectProtocol <String>]
[-RedirectType <String>]
[<CommonParameters>]
Description
Create an in-memory object for RoutingRule.
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"
AcceptedProtocol : {Http, Https}
EnabledState : Enabled
FrontendEndpoint : {{
"id": "/subscriptions/{subid}/resourceGroups/{rg}/providers/Microsoft.Network/frontDoors/{fname}/FrontendEndpoints/frontendEndpoint1"
}}
Id :
Name :
PatternsToMatch : {/*}
ResourceState :
RouteConfiguration : {
"@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
"backendPool": {
"id": "/subscriptions/{subid}/resourceGroups/{rg}/providers/Microsoft.Network/frontDoors/{fname}/BackendPools/backendPool1"
},
"forwardingProtocol": "MatchRequest"
}
RuleEngineId :
Type :
WebApplicationFirewallPolicyLinkId :
Create a PSRoutingRuleObject for Front Door creation with a forwarding rule
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
AcceptedProtocol : {Http, Https}
EnabledState : Enabled
FrontendEndpoint : {{
"id": "/subscriptions/{subid}/resourceGroups/{rg}/providers/Microsoft.Network/frontDoors/{fname}/FrontendEndpoints/frontendEndpoint1"
}}
Id :
Name :
PatternsToMatch : {/*}
ResourceState :
RouteConfiguration : {
"@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
"redirectType": "Moved",
"redirectProtocol": "MatchRequest",
"customHost": "www.contoso.com",
"customPath": "/images/contoso.png",
"customFragment": "section-header-2",
"customQueryString": "field1=value1\u0026field2=value2"
}
RuleEngineId :
Type :
WebApplicationFirewallPolicyLinkId :
Create a PSRoutingRuleObject for Front Door creation
Parameters
-AcceptedProtocol
Protocol schemes to match for this rule.
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
-BackendPoolName
Resource ID.
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
-CacheDuration
The duration for which the content needs to be cached.
Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations ).
HTTP requires the value to be no more than a year.
Parameter properties
Type: TimeSpan
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
-CustomForwardingPath
A 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
-DynamicCompression
Whether to use dynamic compression for cached content.
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
-EnableCaching
Create an in-memory object for RoutingRule.
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.
Permitted values are 'Enabled' or 'Disabled'.
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
-ForwardingProtocol
Protocol this rule will use when forwarding traffic to backends.
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: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FrontendEndpointName
Frontend endpoints associated with this rule.
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
-Id
Resource ID.
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
-Name
Resource name.
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
-PatternsToMatch
The route patterns of the rule.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: PatternToMatch
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-QueryParameter
query parameters to include or exclude (comma separated).
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
-QueryParameterStripDirective
Treatment of URL query terms when forming the cache key.
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.
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.
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
Resource Group name.
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
-RouteConfiguration
Create an in-memory object for RoutingRule.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RuleEngineName
Resource ID.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: RulesEngineName
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WebApplicationFirewallPolicyLinkId
Resource ID.
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 .
Outputs
