Skip to content

Add-SPOSiteDesign.md

Latest commit

 

History

History
192 lines (152 loc) · 4.1 KB

Add-SPOSiteDesign.md

File metadata and controls

192 lines (152 loc) · 4.1 KB
external help file sharepointonline.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/sharepoint-online/add-spositedesign
applicable SharePoint Online
title Add-SPOSiteDesign
schema 2.0.0
author trent-green
ms.author trgreen
ms.reviewer

Add-SPOSiteDesign

SYNOPSIS

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

-Title

The display name of the site design.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SiteScripts

An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed.

Type: SPOSiteScriptPipeBind[]
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

The display description of the site design.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreviewImageUrl

The URL of a preview image. If none is specified, SharePoint uses a generic image.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreviewImageAltText

The alt text description of the image for accessibility.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

RELATED LINKS