Commands › SharePoint Online

Add-SPOSiteDesign

SharePoint Online Microsoft.Online.SharePoint.PowerShell Add-*

Creates a new site design available to users when they create a new site from the SharePoint home page.

Quick start script

# Add-SPOSiteDesign — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Run and inspect
Add-SPOSiteDesign -SiteScripts <SPOSiteScriptPipeBind[]> -Title <String> -WebTemplate <String> | Format-List

# 3. Export for evidence / drift tracking
Add-SPOSiteDesign | Export-Clixml .\SPOSiteDesign-$(Get-Date -Format yyyyMMdd).xml

Syntax

Add-SPOSiteDesign -Title <String> -WebTemplate <String> -SiteScripts <SPOSiteScriptPipeBind[]>
 [-Description <String>] [-ThumbnailUrl <String>] [-PreviewImageUrl <String>] [-PreviewImageAltText <String>]
 [-IsDefault] [-DesignPackageId <Guid>] [<CommonParameters>]

Parameters (9)

ParameterTypeRequiredWhat it controls
-Description String The display description of the site design.
-DesignPackageId Guid The ID of the design package associated with the site design.
-IsDefault SwitchParameter A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](/sharepoint/dev/declarative-customization/customize-default-site-design).
-PreviewImageAltText String The alt text description of the image for accessibility.
-PreviewImageUrl String The URL of a preview image. If none is specified, SharePoint uses a generic image.
-SiteScripts SPOSiteScriptPipeBind[] yes An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed.
-ThumbnailUrl String The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels.
-Title String yes The display name of the site design.
-WebTemplate String yes Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. For more information, visit [SharePoint site design and...

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.