New-SPRequestManagementRuleCriteria
Creates criteria for the rule to match.
Syntax
CustomPropertyParameterSet
New-SPRequestManagementRuleCriteria
[-Value] <String>
[-CustomHeader] <String>
[[-MatchType] <SPRequestManagementRuleMatchType>]
[-CaseSensitive]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
StandardParameterSet
New-SPRequestManagementRuleCriteria
[-Value] <String>
[-Property] <SPRequestManagementRulePropertyType>
[[-MatchType] <SPRequestManagementRuleMatchType>]
[-CaseSensitive]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.
Use the New-SPRequestManagementRuleCriteria cmdlet to create criteria for the rule to match.
Examples
EXAMPLE
New-SPRequestManagementRuleCriteria -Property Host -Value Client01 -MatchType Equals
This example creates a new rule that matches the Host 'Client01'.
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 |
-CaseSensitive
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies whether or not the match is case sensitive.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomHeader
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the custom header for the rule.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CustomPropertyParameterSet
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MatchType
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Defines operators for the match.
The following are the valid values:
--Equals
--Regex
--StartsWith
--EndsWith
Parameter properties
| Type: | SPRequestManagementRuleMatchType |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Property
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies a header for a value to match.
The following are the valid values:
--Url
--Urlreferrer
--UserAgent
--Host
--IP
--HttpMethod
--SoapAction
--CustomHeader
Parameter properties
| Type: | SPRequestManagementRulePropertyType |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
StandardParameterSet
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Value
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies a value for the rule to match.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| 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.