Get-PnPSubWebs.md

external help file	applicable	schema
	SharePoint Server 2013, SharePoint Server 2016, SharePoint Online	2.0.0

Get-PnPSubWebs

SYNOPSIS

Returns the subwebs of the current web

SYNTAX

Get-PnPSubWebs [-Recurse [<SwitchParameter>]]
               [-Identity <WebPipeBind>]
               [-Web <WebPipeBind>]
               [-Connection <SPOnlineConnection>]

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Get-PnPSubWebs

This will return all sub webs for the current web

------------------EXAMPLE 2------------------

PS:> Get-PnPSubWebs -recurse

This will return all sub webs for the current web and its sub webs

PARAMETERS

-Identity

The guid of the web or web object

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: 0
Accept pipeline input: True

-Recurse

include subweb of the subwebs

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional 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

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the 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: False

OUTPUTS

List<Microsoft.SharePoint.Client.Web>

RELATED LINKS

SharePoint Developer Patterns and Practices