Activity Parameters
The following table lists the recommended names and functionality for activity parameters.
| Parameter | Functionality |
|---|---|
| Append Data type: SwitchParameter |
Implement this parameter so that the user can add content to the end of a resource when the parameter is specified. |
| CaseSensitive Data type: SwitchParameter |
Implement this parameter so the user can require case sensitivity when the parameter is specified. |
| Command Data type: String |
Implement this parameter so the user can specify a command string to run. |
| CompatibleVersion Data type: System.Version object |
Implement this parameter so the user can specify the semantics that the cmdlet must be compatible with for compatibility with previous versions. |
| Compress Data type: SwitchParameter |
Implement this parameter so that data compression is used when the parameter is specified. |
| Compress Data type: Keyword |
Implement this parameter so that the user can specify the algorithm to use for data compression. |
| Continuous Data type: SwitchParameter |
Implement this parameter so that data is processed until the user terminates the cmdlet when the parameter is specified. If the parameter is not specified, the cmdlet processes a predefined amount of data and then terminates the operation. |
| Create Data type: SwitchParameter |
Implement this parameter to indicate that a resource is created if one does not already exist when the parameter is specified. |
| Delete Data type: SwitchParameter |
Implement this parameter so that resources are deleted when the cmdlet has completed its operation when the parameter is specified. |
| Drain Data type: SwitchParameter |
Implement this parameter to indicate that outstanding work items are processed before the cmdlet processes new data when the parameter is specified. If the parameter is not specified, the work items are processed immediately. |
| Erase Data type: Int32 |
Implement this parameter so that the user can specify the number of times a resource is erased before it is deleted. |
| ErrorLevel Data type: Int32 |
Implement this parameter so that the user can specify the level of errors to report. |
| Exclude Data type: String[] |
Implement this parameter so that the user can exclude something from an activity. For more information about how to use input filters, see Input Filter Parameters. |
| Filter Data type: Keyword |
Implement this parameter so that the user can specify a filter that selects the resources upon which to perform the cmdlet action. For more information about how to use input filters, see Input Filter Parameters. |
| Follow Data type: SwitchParameter |
Implement this parameter so that progress is tracked when the parameter is specified. |
| Force Data type: SwitchParameter |
Implement this parameter to indicate that the user can perform an action even if restrictions are encountered when the parameter is specified. The parameter does not allow security to be compromised. For example, this parameter lets a user overwrite a read-only file. |
| Include Data type: String[] |
Implement this parameter so that the user can include something in an activity. For more information about how to use input filters, see Input Filter Parameters. |
| Incremental Data type: SwitchParameter |
Implement this parameter to indicate that processing is performed incrementally when the parameter is specified. For example, this parameter lets a user perform incremental backups that back up files only since the last backup. |
| InputObject Data type: Object |
Implement this parameter when the cmdlet takes input from other cmdlets. When you define an InputObject parameter, always specify the ValueFromPipeline keyword when you declare the Parameter attribute. For more information about using input filters, see Input Filter Parameters. |
| Insert Data type: SwitchParameter |
Implement this parameter so that the cmdlet inserts an item when the parameter is specified. |
| Interactive Data type: SwitchParameter |
Implement this parameter so that the cmdlet works interactively with the user when the parameter is specified. |
| Interval Data type: HashTable |
Implement this parameter so that the user can specify a hash table of keywords that contains the values. The following example shows sample values for the Interval parameter: -interval @{ResumeScan=15; Retry=3}. |
| Log Data type: SwitchParameter |
Implement this parameter audit the actions of the cmdlet when the parameter is specified. |
| NoClobber Data type: SwitchParameter |
Implement this parameter so that the resource will not be overwritten when the parameter is specified. This parameter generally applies to cmdlets that create new objects so that they can be prevented from overwriting existing objects with the same name. |
| Notify Data type: SwitchParameter |
Implement this parameter so that the user will be notified that the activity is complete when the parameter is specified. |
| NotifyAddress Data type: Email address |
Implement this parameter so that the user can specify the e-mail address to use to send a notification when the Notify parameter is specified. |
| Overwrite Data type: SwitchParameter |
Implement this parameter so that the cmdlet overwrites any existing data when the parameter is specified. |
| Prompt Data type: String |
Implement this parameter so that the user can specify a prompt for the cmdlet. |
| Quiet Data type: SwitchParameter |
Implement this parameter so that the cmdlet suppresses user feedback during its actions when the parameter is specified. |
| Recurse Data type: SwitchParameter |
Implement this parameter so that the cmdlet recursively performs its actions on resources when the parameter is specified. |
| Repair Data type: SwitchParameter |
Implement this parameter so that the cmdlet will attempt to correct something from a broken state when the parameter is specified. |
| RepairString Data type: String |
Implement this parameter so that the user can specify a string to use when the Repair parameter is specified. |
| Retry Data type: Int32 |
Implement this parameter so the user can specify the number of times the cmdlet will attempt an action. |
| Select Data type: Keyword array |
Implement this parameter so that the user can specify an array of the types of items. |
| Stream Data type: SwitchParameter |
Implement this parameter so the user can stream multiple output objects through the pipeline when the parameter is specified. |
| Strict Data type: SwitchParameter |
Implement this parameter so that all errors are handled as terminating errors when the parameter is specified. |
| TempLocation Data type: String |
Implement this parameter so the user can specify the location of temporary data that is used during the operation of the cmdlet. |
| Timeout Data type: Int32 |
Implement this parameter so that the user can specify the timeout interval (in milliseconds). |
| Truncate Data type: SwitchParameter |
Implement this parameter so that the cmdlet will truncate its actions when the parameter is specified. If the parameter is not specified, the cmdlet performs another action. |
| Verify Data type: SwitchParameter |
Implement this parameter so that the cmdlet will test to determine whether an action has occurred when the parameter is specified. |
| Wait Data type: SwitchParameter |
Implement this parameter so that the cmdlet will wait for user input before continuing when the parameter is specified. |
| WaitTime Data type: Int32 |
Implement this parameter so that the user can specify the duration (in seconds) that the cmdlet will wait for user input when the Wait parameter is specified. |
See Also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for