Export (0) Print
Expand All
Expand Minimize

New-FsrmClassificationRule

Updated: December 6, 2012

Applies To: Windows Server 2012

New-FsrmClassificationRule

Creates an automatic classification rule.

Syntax

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




Detailed 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.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClassificationMechanism<String>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ContentRegularExpression<String[]>

Specifies an array of regular expressions for pattern matching.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ContentString<String[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ContentStringCaseSensitive<String[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the classification rule.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Disabled

Indicates that the classification rule is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies a name for the classification rule.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-Namespace<String[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Parameters<String[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Property<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PropertyValue<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReevaluateProperty<RuleReevaluatePropertyEnum>

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.


Aliases

none

Required?

false

Position?

named

Default Value

Never

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationRule

Examples

Example 1: Create a classification rule

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.


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

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

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft