Edit

Share via

New-SPRequestManagementRuleCriteria

  • Reference
Module:
SharePointServer
Applies to:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Creates criteria for the rule to match.

Syntax

New-SPRequestManagementRuleCriteria
   [-Value] <String>
   [-CustomHeader] <String>
   [-CaseSensitive]
   [[-MatchType] <SPRequestManagementRuleMatchType>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]
New-SPRequestManagementRuleCriteria
   [-Value] <String>
   [-Property] <SPRequestManagementRulePropertyType>
   [-CaseSensitive]
   [[-MatchType] <SPRequestManagementRuleMatchType>]
   [-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

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-CaseSensitive

Specifies whether or not the match is case sensitive.

Type:SwitchParameter
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-CustomHeader

Specifies the custom header for the rule.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-MatchType

Defines operators for the match.

The following are the valid values:

--Equals

--Regex

--StartsWith

--EndsWith

Type:SPRequestManagementRuleMatchType
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Property

Specifies a header for a value to match.

The following are the valid values:

--Url

--Urlreferrer

--UserAgent

--Host

--IP

--HttpMethod

--SoapAction

--CustomHeader

Type:SPRequestManagementRulePropertyType
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Value

Specifies a value for the rule to match.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019