Commands › SharePoint Online

Set-SPOSiteDesign

SharePoint Online Microsoft.Online.SharePoint.PowerShell Set-*

Updates a previously uploaded site design.

Quick start script

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

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SPOSiteDesign
$before | Format-List

# 3. Make the change
Set-SPOSiteDesign -Identity <SPOSiteDesignPipeBind>

# 4. Verify and diff
$after = Get-SPOSiteDesign
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-SPOSiteDesign [-Identity] <SPOSiteDesignPipeBind> [-Title <String>] [-WebTemplate <String>]
 [-SiteScripts <SPOSiteScriptPipeBind[]>] [-Description <String>] [-ThumbnailUrl <String>]
 [-PreviewImageUrl <String>] [-PreviewImageAltText <String>] [-IsDefault <Boolean>] [-Version <Int32>]
 [-DesignPackageId <Guid>] [<CommonParameters>]

Parameters (11)

ParameterTypeRequiredWhat it controls
-Description String The display description of the site design.
-DesignPackageId Guid The new design package to associate with this site design.
-Identity SPOSiteDesignPipeBind yes The site design Id.
-IsDefault Boolean 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[] 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 The display name of the site design.
-Version Int32 The new version number of the site design.
-WebTemplate String 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.

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