Table of Contents

Remove-PnPSiteDesignTask

SYNOPSIS

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

Removes a site design task.

SYNTAX

Remove-PnPSiteDesignTask [-Identity] <TenantSiteDesignTaskPipeBind> [-Force] [-Connection <PnPConnection>]

DESCRIPTION

This cmdlet removes a site design task. If the execution of the associated site script has already started, the execution will not be terminated.

EXAMPLES

EXAMPLE 1

Remove-PnPSiteDesignTask -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd

Removes the specified site design task.

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

-Force

If specified you will not be asked to confirm removing the specified site design.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

The ID of the site design task to remove.

Type: TenantSiteDesignTaskPipeBind
Parameter Sets: (All)

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Microsoft 365 Patterns and Practices