SharePoint Online: How to Create a Site Design from Existing Site using PowerShell?

How to Create a New Site Collection from an existing site in SharePoint Online?

With the Get-SPOSiteScriptFromWeb cmdlet, we can create a site design from an existing site collection and then use the site design to create new instances of the site. The cmdlet is a new feature addition to SharePoint Online! It extracts the site schema from a given site and can be used to create copies of any existing site structure. Here are the basic syntax and examples:

Syntax:
Get-SPOSiteScriptFromWeb -WebUrl $siteUrl -IncludeTheming -IncludeBranding -IncludeSiteExternalSharingCapability -IncludeRegionalSettings -IncludeLists $RelativeListUrls

Example:
Get-SPOSiteScriptFromWeb -WebURL https://crescent.sharepoint.com/sites/marketing  -IncludeBranding -IncludeTheme -IncludeRegionalSettings -IncludeSiteExternalSharingCapability -IncludedLists (“Lists/work”,”Shared%20Documents”)

Create Site Design from an Existing site using PowerShell

Before using this cmdlet, make sure you have the updated SharePoint Online PowerShell module installed: How to Update SharePoint Online PowerShell Module?

#Define Parameters
$AdminCenterURL = "https://crescent-admin.sharepoint.com"
$SiteURL = "https://crescent.sharepoint.com"
 
#Connect to SharePoint Online
Connect-SPOService -Url $AdminCenterURL -credential (Get-Credential)
 
#Get the site schema
$SiteSchema = Get-SPOSiteScriptFromWeb -WebURL $SiteURL -IncludeBranding -IncludeTheme -IncludeRegionalSettings -IncludeSiteExternalSharingCapability -IncludedLists ("Lists/Events","Shared%20Documents")
 
#Add site schema as Site Script 
$SiteScript = Add-SPOSiteScript -Title "Crescent Site Template v1" -Content $SiteSchema
 
#Create a Site Design for Team Site template
$SiteDesign = Add-SPOSiteDesign -Title "Crescent Site Template v1" -WebTemplate 64 -SiteScripts $SiteScript.Id

To get a list of web template IDs, refer: Get SharePoint Online Web Template IDs

Once the site template is created, You can create a new site collection based on the site design you created:

Update: Site Designs are moved from Create Site page to the “Apply Site Template” page! They are No more listed Here!
Create site template using site design

So, you can apply the site design after creating a new site. Click on Settings hear >> Apply site template >> From your organization.

Salaudeen Rajack

Salaudeen Rajack - SharePoint Expert with Two decades of SharePoint Experience. Love to Share my knowledge and experience with the SharePoint community, through real-time articles!

6 thoughts on “SharePoint Online: How to Create a Site Design from Existing Site using PowerShell?

  • I am getting a file not found error

    Reply
    • That’s because: I’ve included “Events” list as part of “IncludedLists” parameter. You may not have the “Events” list in your site! So remove that list from the parameter value.

      Reply
  • I am not able to see the site design dropdown in my case . The script ran successfully. But I am not able to find it on SP Admin center or on Subsite creation.

    Reply
    • Now, It’s moved under “Apply a Site Template” >> “From your organization” section of site collections.

      Reply
  • Hello, this is fantastic. Can this work for a subsite?

    Reply
  • Thanks for the update

    Reply

Leave a Reply

Your email address will not be published. Required fields are marked *