SharePoint site design: PnP PowerShell cmdlets

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

Note

PnP PowerShell is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.

Getting started

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

1. Download and install the PnP PowerShell Module by running:

   Install-Module PnP.PowerShell
   

2. Connect to the SharePoint Online Admin Center of your tenant:

   Connect-PnPOnline -Url https://tenant-admin.sharepoint.com -Interactive
   

To verify your setup and connection, try using the Get-PnPSiteScript 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 PnP PowerShell:

• Add-PnPSiteDesign
• Add-PnPSiteDesignTask
• Add-PnPSiteScript
• Add-PnPSiteScriptPackage
• Get-PnPSiteDesign
• Get-PnPSiteDesignRights
• Get-PnPSiteDesignRun
• Get-PnPSiteDesignRunStatus
• Get-PnPSiteDesignTask
• Get-PnPSiteScript
• Get-PnPSiteScriptFromList
• Get-PnPSiteScriptFromWeb
• Grant-PnPSiteDesignRights
• Invoke-PnPSiteDesign
• Remove-PnPSiteDesign
• Remove-PnPSiteDesignTask
• Remove-PnPSiteScript
• Revoke-PnPSiteDesignRights
• Set-PnPSiteDesign
• Set-PnPSiteScript
• Set-PnPSiteScriptPackage

See also

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