Get-PnPSubWeb
SYNOPSIS
Returns the subwebs of the current web
SYNTAX
Get-PnPSubWeb [[-Identity] <WebPipeBind>] [-Recurse] [-Connection <PnPConnection>]
[-Includes <String[]>]
DESCRIPTION
Allows to retrieve subwebs of the current web.
EXAMPLES
EXAMPLE 1
Get-PnPSubWeb
Retrieves all subsites of the current context returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output
EXAMPLE 2
Get-PnPSubWeb -Recurse
Retrieves all subsites of the current context and all of their nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output
EXAMPLE 3
Get-PnPSubWeb -Recurse -Includes "WebTemplate","Description" | Select ServerRelativeUrl, WebTemplate, Description
Retrieves all subsites of the current context and shows the ServerRelativeUrl, WebTemplate and Description properties in the resulting output
EXAMPLE 4
Get-PnPSubWeb -Identity Team1 -Recurse
Retrieves all subsites of the subsite Team1 and all of its nested child subsites
EXAMPLE 5
Get-PnPSubWeb -Identity Team1 -Recurse -IncludeRootWeb
Retrieves the root web, all subsites of the subsite Team1 and all of its nested child subsites
PARAMETERS
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
If provided, only the subsite with the provided Id, GUID or the Web instance will be returned
Type: WebPipeBind
Parameter Sets: (All)
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Recurse
If provided, recursion through all subsites and their children will take place to return them as well
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeRootWeb
If provided, the results will also contain the root web
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False