Get-WssMsoSharePointLibrary
Get-WssMsoSharePointLibrary
Retrieves a library.
Syntax
Parameter Set: Default
Get-WssMsoSharePointLibrary [[-Name] <String> ] [[-Site] <SharePointSite> ] [ <CommonParameters>]
Detailed Description
The Get-WssMsoSharePointLibrary cmdlet retrieves a library. A site stores the library.
Parameters
-Name<String>
Specifies the name of a library. The cmdlet gets the library for the name that you specify. If you do not specify the Name parameter, the cmdlet returns libraries in the default team site that match other parameters.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Site<SharePointSite>
Specifies a site. The cmdlet gets the library for the site that you specify. If you do not specify the Site parameter, the cmdlet returns libraries in the default team site that match other parameters.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
System.String
Name
Type: System.String
Description: Name of the SharePoint library
Outputs
The output type is the type of the objects that the cmdlet emits.
- SharePointLibrary[]
Examples
Example 1: Get a SharePoint library
The first command uses the Get-WssMsoSharePointSite cmdlet to get a site, and stores the result in the $Site variable.
The second command gets the SharePoint Online library for the site specified in the $Site variable.
PS C:\> $Site = Get-WssMsoSharePointSite | Select-Object -First 1
PS C:\> Get-WssMsoSharePointLibrary -Name "Documents" -Site $Site
PS C:\>