Add-SPOSiteDesign
Creates a new site design available to users when they create a new site from the SharePoint home page.
Syntax
Default (Default)
Add-SPOSiteDesign
-Title <String>
-WebTemplate <String>
-SiteScripts <SPOSiteScriptPipeBind[]>
[-Description <String>]
[-ThumbnailUrl <String>]
[-PreviewImageUrl <String>]
[-PreviewImageAltText <String>]
[-IsDefault]
[-DesignPackageId <Guid>]
[<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
Applicable: SharePoint Online
The display description of the site design.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DesignPackageId
{{ Fill DesignPackageId Description }}
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsDefault
Applicable: SharePoint Online
A switch that if provided, applies the site design to the default site template. For more information, see Customize a default site design.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PreviewImageAltText
Applicable: SharePoint Online
The alt text description of the image for accessibility.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PreviewImageUrl
Applicable: SharePoint Online
The URL of a preview image. If none is specified, SharePoint uses a generic image.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteScripts
Applicable: SharePoint Online
An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ThumbnailUrl
Applicable: SharePoint Online
The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Title
Applicable: SharePoint Online
The display name of the site design.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebTemplate
Applicable: SharePoint Online
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.