Microsoft.SharePoint.PowerShell namespace

  • Article

Base classes that permit you to create custom Windows PowerShell for SharePoint cmdlets.

When writing custom Windows PowerShell cmdlets to operate in the SharePoint Foundation 2010 context, it is important that you inherit from these base classes, which provide SharePoint-specific implementations of the core PowerShell classes.

Classes

  Class Description
Public class SPAssignmentCollection This class and its members are reserved for internal use and are not intended to be used in your code.
Public class SPCmdlet Represents an abstract base class for all custom cmdlets that are written to be used in SharePoint deployments, providing uniform behavior across all SharePoint cmdlets.
Public class SPCmdletAttribute Specifies the attributes to apply to a cmdlet that inherits from SPCmdlet.
Public class SPCmdletDistributedCacheClusterInfoManagerPipeBind Contract for Cmdlet parameters that represent an SPDistributedCacheClusterInfoManager Identity
Public class SPCmdletException Exception class that uses localized strings instead of hard-coded strings.
Public class SPCmdletGetSPSiteUrl
Public class SPCmdletPipeBind<TCmdletObject> An abstract class that represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. This generic base class for SharePoint pipebind classes takes a generic type of TCmdletObject. The SPCmdletPipeBind<TCmdletObject> class provides the abstract methods Read and Discover. The cmdlet classes use the Read method to retrieve results. The Read method retrieves the object instance that represents the parameters associated with the current pipebind object; the Discover method populates the information that is required to retrieve or recreate the given object. All derived classes must override and implement these methods.
Public class SPCmdletPipeBindException Exception class used by classes that inherit from SPCmdletPipeBind classes to indicate that an exception occurred.
Public class SPCmdletRemoveSPSiteUrl
Public class SPCmdletSetSPSiteUrl
Public class SPCmdletSPSiteUrlBase
Public class SPContentDatabasePipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to a content database in a Microsoft SharePoint Foundation deployment. This class facilitates the binding to and handling of input parameters as an instance of an SPContentDatabase object, a GUID referencing an object, and as the string representation of a GUID.
Public class SPDeletedSitePipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters.
Public class SPDistributedCacheClientSettings Specifies the configuration settings for a cache client.
Public class SPGetCmdletBase<TCmdletObject> Abstract base class that allows derived classes to find and return a set of objects of type TCmdletObject.
Public class SPHealthAnalysisRuleInstancePipeBind Helper cmdlet class for SPHealthAnalysisRule identity parameter.
Public class SPIisWebServiceApplicationPoolPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to an IIS Web service application pool in a server farm. This class facilitates the binding to and handling of input parameters as an instance of a service application object or as a GUID or string identifier.
Public class SPNewCmdletBase<TCmdletObject> An abstract base class that is used to create new instances of objects and save them to the data store.
Public class SPPrefixPipeBind Represents a binding for pipeline or command-line input parameters to a Windows PowerShell cmdlet. The binding that this class represents is to input parameters specific to a SharePoint FoundationSPPrefix object. For more information about PipeBind objects, see Key Concepts for Writing Cmdlets for SharePoint Foundation 2010.
Public class SPRemoveCmdletBase<TCmdletObject> An abstract base class that removes an existing data object of the specified type from the data store.
Public class SPRequestManagementRuleCriteriaPipeBind Contract for Cmdlet parameters that represent an SPRequestManagementRuleCriteria Identity
Public class SPRequestManagementSettingsPipeBind Contract for Cmdlet parameters that represent an SPRequestManagementSettings Identity
Public class SPRoutingMachineInfoPipeBind Contract for Cmdlet parameters that represent an SPRoutingMachineInfo Identity Note: this is similar to [SPRoutingRuleTargetPipeBind] but does not allow machine name only resolving of objects. The object must be passed in.
Public class SPRoutingMachinePoolPipeBind Contract for Cmdlet parameters that represent an SPRoutingMachinePool Identity
Public class SPRoutingRulePipeBind Contract for Cmdlet parameters that represent an SPRoutingRule Identity
Public class SPRoutingRuleTargetPipeBind Contract for Cmdlet parameters that represent an SPRoutingMachineInfo Identity Note: this is similar to [SPRoutingMachineInfoPipeBind] with the addition of being able to resolve the object using the machine name only by calling and additional [Initialize] method.
Public class SPServerPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to a SharePoint Server instance represented by an SPServer object. This class facilitates the binding to and handling of input parameters as objects, a GUID referencing an object, and as string representations.
Public class SPServiceApplicationPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to SharePoint service applications that are represented as SPServiceApplication objects. This class facilitates the binding to and handling of input parameters as an instance of an SPServiceApplication object, a GUID identifier, or a string representation of a GUID.
Public class SPServiceApplicationProxyPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to SharePoint Service proxy applications that are represented as SPServiceApplicationProxy objects. This class facilitates the binding to and handling of input parameters as an instance of an SPServiceApplicationProxy object, a GUID identifier, or a string representation of a GUID.
Public class SPServiceContextPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to SharePoint Service context that is represented as an SPServiceContext object. This class facilitates the binding to and handling of input parameters as an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or any of the following belonging to an SPSite object: An identifier from the Id field, a string identifier, a URI or a string representation of a GUID.
Public class SPSetCmdletBase<TCmdletObject> An abstract base class that derived classes can use to update properties for existing objects in the data store.
Public class SPSitePipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. This class facilitates the binding to and handling of input parameters as a string representation of a GUID reference, a string representation of a URI, a GUID or URI referencing an SPSite object, the SPSite object itself, or an SPSiteAdministration object.
Public class SPSiteSubscriptionPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to the loose association of SharePoint sites represented by an SPSiteSubscription object. This class facilitates the binding to and handling of input parameters as an instance of an SPSiteSubscription object, the URI or URL of an SPSite object, or the GUID identifier of the SPSiteSubscription object.
Public class SPThrottlingRulePipeBind Contract for Cmdlet parameters that represent an SPThrottlingRule Identity
Public class SPTrustedSecurityTokenServicePipeBind Contract for Cmdlet parameters that represent an SPTrustedProviderBase Identity.
Public class SPUserSettingsProviderPipeBind Represents SPUserSettingsProvider parameter.
Public class SPWebApplicationPipeBind Represents a binding for pipeline or command-line input parameters to PowerShell cmdlets. The binding that this class represents is to input parameters specific to a Microsoft SharePoint Foundation 2010 Web application. This class facilitates the binding to and handling of input parameters as an SPWebApplication object instance, as the string representation of a GUID that references an object, as a name of the Web application, or as the URL of the Web application.
Public class SPWebPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. This class facilitates the binding to and handling of input parameters as a SharePoint Web site, and as the string representation of a GUID reference to or the URL of the site.
Public class SPWopiBinding A SharePoint WOPI binding is an association between a file type, a WOPI action and a WOPI zone. A typical WOPI application will support several bindings that map to both different file types and different supported WOPI actions.
Public class SPWopiBindingPipeBind Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. This class facilitates the binding to and handling of input parameters as a SharePoint WOPI binding, which represents a combination of file type and action.