Set-SPRoutingRule
Changes properties of an existing routing rule.
Syntax
Default (Default)
Set-SPRoutingRule
[-Identity] <SPRoutingRulePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>]
[-ExecutionGroup <Int32>]
[-Expiration <DateTime>]
[-MachinePool <SPRoutingMachinePoolPipeBind>]
[<CommonParameters>]
Description
Use the Set-SPRoutingRule cmdlet to change properties of an existing routing rule.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE
$wa = Get-SPWebApplication https://webAppUrl
$rm = Get-SPRequestManagementSettings -Identity $wa
Get-SPRoutingRule -RequestManagementSettings $rm
$machines = Get-SPRoutingMachineInfo -RequestManagementSettings $rm
$pool = Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines
$criteria = New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false
$rule = Add-SPRoutingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -MachinePool $pool
$criteriaNew = New-SPRequestManagementRuleCriteria -Property UserAgent -MatchType Equals -Value "Mozilla/4.0 (compatible; MSIE 4.01; Windows NT; MS Search 6.0 Robot)"
Set-SPRoutingRule -Identity $rule -Criteria $criteriaNew
This example sets a routing rule for the specified identity by using the $rule variable.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Criteria
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the criteria for the rule to match.
Parameter properties
| Type: | SPRequestManagementRuleCriteriaPipeBind[] |
| 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 |
-ExecutionGroup
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the group in which the rule will be placed.
Parameter properties
| Type: | Int32 |
| 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 |
-Expiration
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the expiration date and time of the rule.
Parameter properties
| Type: | DateTime |
| 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 |
-Identity
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name of the request management settings object to set.
Parameter properties
| Type: | SPRoutingRulePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MachinePool
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the pool of machines to which a request will be routed if the changed rule is matched.
Parameter properties
| Type: | SPRoutingMachinePoolPipeBind |
| 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.