Edit

Share via

New-FsrmClassificationRule

  • Reference
Module:
FileServerResourceManager

Creates an automatic classification rule.

Syntax

New-FsrmClassificationRule
   [-Name] <String>
   [-Description <String>]
   -Property <String>
   [-PropertyValue <String>]
   -Namespace <String[]>
   [-Disabled]
   [-ReevaluateProperty <RuleReevaluatePropertyEnum>]
   [-Flags <RuleFlagsEnum[]>]
   [-ContentRegularExpression <String[]>]
   [-ContentString <String[]>]
   [-ContentStringCaseSensitive <String[]>]
   -ClassificationMechanism <String>
   [-Parameters <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-FsrmClassificationRule cmdlet creates an automatic classification rule on the server. Each rule sets the value for a single property. By default, a rule runs only once and ignores files that already have a property value assigned. However, you can configure a rule to evaluate files regardless of whether a value is already assigned to the property.

Examples

Example 1: Create a classification rule

PS C:\> New-FsrmClassificationRule -Name "Find confidential files" -Namespace @("C:\shares\CtrShare03") -Property "Impact" -PropertyValue "High" -ClassificationMechanism "Content Classifier" -ContentString "Confidential"

This command creates a classification rule that marks any files as Impact=High if the files contain the word Confidential and the files do not already have an Impact property.

Example 2: Create a classification rule and overwrite the property value

PS C:\> New-FsrmClassificationRule -Name "Find confidential files" -Namespace @("C:\shares\CtrShare03") -Property "Impact" -PropertyValue "High" -ClassificationMechanism "Content Classifier" -ContentString "confidential" -ReevaluateProperty Overwrite

This command creates a classification rule that marks any files as Impact=High if they contain the word Confidential, and overwrites any existing Impact property value.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClassificationMechanism

Specifies the name of a valid classification mechanism available on the server for assigning the property value.

The classification mechanisms are provided by a series of plug-ins that are included with Windows Server® 2012 or produced by you or an ISV.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentRegularExpression

Specifies an array of regular expressions for pattern matching.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContentString

Specifies an array of strings for the content classifier to search for.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContentStringCaseSensitive

Specifies an array of case sensitive strings for the content classifier to search for.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Description

Specifies a description for the classification rule.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Disabled

Indicates that the classification rule is disabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Flags

Specifies an array of flags that defines the possible states of the rule. The acceptable values for this parameter are:

  • ClearAutomaticallyClassifiedProperty. Integer value 1024.
  • ClearManuallyClassifiedProperty. Integer value 2048.
  • Deprecated. Integer value 4096.
Type:RuleFlagsEnum[]
Accepted values:ClearAutomaticallyClassifiedProperty, ClearManuallyClassifiedProperty, Deprecated
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a name for the classification rule.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Namespace

Specifies an array of namespaces where the rule is applied. Each value must be either a value of the FolderType property defined on the server (using the format "[Folder type property name=<value>]") or a static path.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

Specifies an array of strings using the format <name>=<value>. The File Classification Infrastructure and other management tools use these parameters.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Specifies the name of a classification property definition to set. Specify the value of the Name property in a FsrmClassificationPropertyDefinition object.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PropertyValue

Specifies the property value that the rule will assign. The property value that you set must be an valid value supported by the classification mechanism that you specify in the ClassificationMechanism parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReevaluateProperty

Specifies the evaluation policy of the rule. The acceptable values for this parameter are:

  • Never: Assign values to properties only if that property does not already have a value for the file.
  • Overwrite: Reclassify files when the files change and overwrite this property.
  • Aggregate: Reclassify files when the files change and aggregate the new value for the property with the existing value.
Type:RuleReevaluatePropertyEnum
Accepted values:Never, Aggregate, Overwrite
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

String[]

Outputs

Object