Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 2.41 KB

Remove-PnPWeb.md

File metadata and controls

116 lines (87 loc) · 2.41 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPWeb

SYNOPSIS

Removes a subweb in the current web

SYNTAX

ByUrl

Remove-PnPWeb -Url <String>
              [-Force [<SwitchParameter>]]
              [-Web <WebPipeBind>]
              [-Connection <SPOnlineConnection>]

ByIdentity

Remove-PnPWeb -Identity <WebPipeBind>
              [-Force [<SwitchParameter>]]
              [-Web <WebPipeBind>]
              [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Remove-PnPWeb -Url projectA

Remove a web

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

PS:> Remove-PnPWeb -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0

Remove a web specified by its ID

------------------EXAMPLE 3------------------

PS:> Get-PnPSubWebs | Remove-PnPWeb -Force

Remove all subwebs and do not ask for confirmation

PARAMETERS

-Force

Do not ask for confirmation to delete the subweb

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Identity

Identity/Id/Web object to delete

Type: WebPipeBind
Parameter Sets: ByIdentity

Required: True
Position: Named
Accept pipeline input: True

-Url

The site relative url of the web, e.g. 'Subweb1'

Type: String
Parameter Sets: ByUrl

Required: True
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

RELATED LINKS

SharePoint Developer Patterns and Practices