Edit

Share via


New-FsrmClassificationPropertyDefinition

Creates a classification property definition.

Syntax

Default (Default)

New-FsrmClassificationPropertyDefinition
    [-Name] <String>
    [-DisplayName <String>]
    [-Description <String>]
    -Type <PropertyDefinitionTypeEnum>
    [-PossibleValue <CimInstance[]>]
    [-Parameters <String[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-FsrmClassificationPropertyDefinition cmdlet creates a classification property definition on the server. You create a property definition to define the property that you want to use to classify files. One or more classification rules can specify the property. The File Server Resource Manager (FSRM) server limits the number of property definitions to 100.

Examples

Example 1: Create a YesNo classification property definition

PS C:\> New-FsrmClassificationPropertyDefinition -Name "ClassProp01" -DisplayName "Central Level Definitions" -Type YesNo

This command creates a YesNo classification property definition that named ClassProp01 with a display name of Central Level Definitions.

Example 2: Create an ordered list classification property definition

PS C:\> New-FsrmClassificationPropertyDefinition -Name "Impact" -Type OrderedList -PossibleValue @("High","Moderate","Low")

This command creates an OrderedList classification property definition named Impact, and specifies the possible values for 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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the property definition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DisplayName

Specifies an optional name for the property.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies a name for the property.

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:True
Value from remaining arguments:False

-Parameters

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PossibleValue

Specifies an array of property values. The default value is an empty list. You can use the New-FsrmClassificationPropertyValue cmdlet to create possible values for a classification property.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

Specifies the type of the classification property definition. The acceptable values for this parameter are:

  • OrderedList
  • MultiChoice
  • SingleChoice
  • String
  • MultiString
  • Integer
  • YesNo
  • DateTime

Parameter properties

Type:PropertyDefinitionTypeEnum
Default value:None
Accepted values:OrderedList, MultiChoice, SingleChoice, String, MultiString, Integer, YesNo, DateTime
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
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.

Inputs

String

Microsoft.PowerShell.Cmdletization.GeneratedTypes.PropertyDefinitionTypeEnum

String

Outputs

Object