Remove-SPOSiteDesignTask
Command to remove a scheduled site design script.
Syntax
Default (Default)
Remove-SPOSiteDesignTask
[-Identity] <SPOSiteDesignTaskPipeBind>
[<CommonParameters>]
Description
Removes a scheduled site design by providing the site design ID. If the execution of the associated site script has already started the execution will not be terminated.
Note
This command only removes a scheduled request. To check on the job status or to view details of the scheduled run, use the commands in the related section below.
Examples
Example 1
This example removes a previously scheduled site design.
Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82
Parameters
-Identity
Applicable: SharePoint Online
The ID of the site design to apply.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.