SharePoint CmdLet with PipeBind

Adds a SharePoint cmdlet which uses or returns objects from the pipe (e.g. Get-SPSiteTitle, Set-SPSiteTitle). The recipe creates the cmdlet class, the class for the piped object, the xml for the registration in SharePoint and a corresponding help file to store help information about the cmdlet.

Recipe Description

The custom cmdlet can be used in powershell scripts (.ps1) to handle objects e.g. SPList or SPSite within a pipe.
Use command "Get-Help Get-MyCustomList' to display a detailed help information.
Use command "Get-Command Get-MyCustomList' to display general information.

Screens




Arguments

Name Description
General Settings
Generated Command Optional String. Displays the final command
Verb Required String. Select the verb e.g. "Get", "New", "Set", "Delete".
Noun Required String. Enter the operation or object type e.g. "SPSiteByName".
Description Required String. Enter the a short description of the cmdlet (used in help file).
Pipe Object Settings
Object Type Optional String. Enter the existing type of object that should be used for pipe binding (e.g. SPList, SPWeb).

References

Authors

  • Torsten Mandelkow

Version history

  • 1.0 Initial Recipe