Add-SPOSiteDesign
Creates a new site design available to users when they create a new site from the SharePoint home page.
Syntax
Add-SPOSiteDesign
-Title <string>
-WebTemplate <string>
-SiteScripts <SPOSiteScriptPipeBind[]>
[-Description <string>]
[-ThumbnailUrl <string>]
[-PreviewImageUrl <string>]
[-PreviewImageAltText <string>]
[-IsDefault]
[<CommonParameters>] Description
Creates a new site design available to users when they create a new site from the SharePoint home page.
Examples
Example 1
This example creates a new site design.
Add-SPOSiteDesign `
-Title "Contoso customer tracking" `
-WebTemplate "64" `
-SiteScripts "<ID>" `
-Description "Tracks key customer data in a list" `
-ThumbnailUrl "https://contoso.sharepoint.com/SiteAssets/site-thumbnail.png" `
-PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" `
-PreviewImageAltText "site preview"Parameters
-Description
The display description of the site design.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-IsDefault
A switch that if provided, applies the site design to the default site template. For more information, see Customize a default site design.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-PreviewImageAltText
The alt text description of the image for accessibility.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-PreviewImageUrl
The URL of a preview image. If none is specified, SharePoint uses a generic image.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SiteScripts
An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed.
| Type: | SPOSiteScriptPipeBind[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-ThumbnailUrl
The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Title
The display name of the site design.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-WebTemplate
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 site script overview.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |