SharePoint site design: PowerShell cmdlets

Use PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.

Getting started

To run the PowerShell cmdlets, you'll need to do the following:

1. Download and install the SharePoint Online Management Shell. If you already have a previous version of the shell installed, uninstall it first and then install the latest version.
2. Follow the instructions at Connect to SharePoint Online PowerShell to connect to your SharePoint tenant.

To verify your setup, try using the Get-SPOSiteScript cmdlet to read the current list of site scripts. If the cmdlet runs and returns with no errors, you're ready to proceed.

Site design cmdlets

The following cmdlets are available for managing site designs and site scripts from PowerShell:

• Add-SPOSiteDesign
• Add-SPOSiteDesignTask
• Add-SPOSiteScript
• Get-SPOSiteDesign
• Get-SPOSiteDesignRights
• Get-SPOSiteDesignRun
• Get-SPOSiteDesignRunStatus
• Get-SPOSiteDesignTask
• Get-SPOSiteScript
• Get-SPOSiteScriptFromWeb
• Get-SPOSiteScriptFromList
• Grant-SPOSiteDesignRights
• Invoke-SPOSiteDesign
• Remove-SPOSiteDesign
• Remove-SPOSiteDesignTask
• Remove-SPOSiteScript
• Revoke-SPOSiteDesignRights
• Set-SPOSiteDesign
• Set-SPOSiteScript

See also

• JSON schema reference
• REST API
• Apply a scope to your site design
• SharePoint site design and site script overview
• SharePoint site design - PnP PowerShell commands
• SharePoint site design - CLI for Microsoft 365 commands