| external help file | applicable | schema |
|---|---|---|
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online |
2.0.0 |
Return a folder object
Get-PnPFolder -Url <String>
[-Web <WebPipeBind>]
[-Includes <String[]>]
[-Connection <SPOnlineConnection>]Retrieves a folder if it exists. Use Ensure-PnPFolder to create the folder if it does not exist.
PS:> Get-PnPFolder -RelativeUrl "Shared Documents"Returns the folder called 'Shared Documents' which is located in the root of the current web
PS:> Get-PnPFolder -RelativeUrl "/sites/demo/Shared Documents"Returns the folder called 'Shared Documents' which is located in the root of the current web
Specify properties to include when retrieving objects from the server.
Type: String[]
Parameter Sets:
Required: False
Position: 0
Accept pipeline input: FalseSite or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web.
Type: String
Parameter Sets: (All)
Aliases: RelativeUrl
Required: True
Position: 0
Accept pipeline input: TrueThe web to apply the command to. Omit this parameter to use the current web.
Type: WebPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseOptional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: SPOnlineConnection
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False