Remove-WssMsoSharePointLibrary
Remove-WssMsoSharePointLibrary
Removes a library.
Syntax
Parameter Set: Default
Remove-WssMsoSharePointLibrary [-Library] <SharePointLibrary> [[-Force]] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-WssMsoSharePointLibrary cmdlet removes a library. A site stores the library.
Parameters
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Library<SharePointLibrary>
Specifies a library object. The cmdlet removes the library that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
Library
Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
Description: SharePoint library
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a SharePoint library
The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the $Library variable.
The second command removes the library named $Library.
PS C:\> $Library = Get-WssMsoSharePointLibrary | Select-Object -First 1
PS C:\> Remove-WssMsoSharePointLibrary -Library $Library
PS C:\>