New-AzFrontDoorRoutingRuleObject
Create a PSRoutingRuleObject for Front Door creation
Syntax
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>] 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}
| Type: | PSProtocol[] |
| Accepted values: | Http, Https |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackendPoolName
Resource id of the BackendPool which this rule routes to
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomForwardingPath
The custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomFragment
Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomHost
Host to redirect. Leave empty to use the incoming host as the destination host.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 &.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DynamicCompression
Whether to enable dynamic compression for cached content when caching is enabled. Default value is Enabled
| Type: | PSEnabledState |
| Accepted values: | Enabled, Disabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableCaching
Whether to enable caching for this route. Default value is false
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnabledState
Whether to enable use of this rule. Default value is Enabled
| Type: | PSEnabledState |
| Accepted values: | Enabled, Disabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForwardingProtocol
The protocol this rule will use when forwarding traffic to backends Default value is MatchRequest.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FrontDoorName
The name of the Front Door to which this routing rule belongs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FrontendEndpointName
The names of Frontend endpoints associated with this rule
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
RoutingRule name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 /*
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-QueryParameterStripDirective
The treatment of URL query terms when forming the cache key. Default value is StripAll
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RedirectProtocol
The protocol of the destination to where the traffic is redirected. Default value is MatchRequest
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RedirectType
The redirect type the rule will use when redirecting traffic. Default Value is Moved
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name that the RoutingRule will be created in.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RulesEngineName
A reference to a specific Rules Engine Configuration to apply to this route.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
Related Links
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for