Set-FsrmClassificationRule

Changes configuration settings of classification rules.

Syntax

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

Description

The Set-FsrmClassificationRule cmdlet changes configuration settings of one or more classification rules.

Examples

Example 1: Change a classification rule

PS C:\> Set-FsrmClassificationRule -Name "Find confidential files" -ContentString @("confidential", "secret")

This command changes the "Find confidential files" rule to search for the strings "confidential" and "secret".

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies an array of names of classification rules.

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

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

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value: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
Accept pipeline input:False
Accept wildcard characters:False
-ContentString

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

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

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

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

Specifies a description for the classification rule.

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

Indicates that the classification rule is disabled.

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

Specifies an array of flags that define the possible states of the rule.

Type:RuleFlagsEnum[]
Parameter Sets:ClearAutomaticallyClassifiedProperty, ClearManuallyClassifiedProperty, Deprecated
Position:Named
Default value:None
Accept pipeline input:False
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 (in the format "[Folder type property name=<value>]") or a static path.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

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

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

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

Type:String
Position:Named
Default value:None
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
Parameter Sets:Never, Aggregate, Overwrite
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationRule