Skip to content

Set-SPOSiteDesign.md

Latest commit

 

History

History
267 lines (190 loc) · 5.45 KB

Set-SPOSiteDesign.md

File metadata and controls

267 lines (190 loc) · 5.45 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/set-spositedesign
applicable SharePoint Online
title Set-SPOSiteDesign
schema 2.0.0
author samkabue
ms.author speedta
ms.reviewer

Set-SPOSiteDesign

SYNOPSIS

Updates a previously uploaded site design.

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>]

DESCRIPTION

Updates a previously uploaded site design.

EXAMPLES

Example 1

This example updates a previously created site design.

Set-SPOSiteDesign `
  -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
  -Title "Contoso customer tracking - version 2" `
  -WebTemplate "68" `
  -Description "Updated site design for list schema that 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 - version 2"

DESCRIPTION

This cmdlet updates a previously uploaded site design.

PARAMETERS

-Description

Applicable: SharePoint Online

The display description of the site design.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DesignPackageId

Applicable: SharePoint Online

The new design package to associate with this site design.

Type: System.Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Applicable: SharePoint Online

The site design Id.

Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: 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.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreviewImageAltText

Applicable: SharePoint Online

The alt text description of the image for accessibility.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreviewImageUrl

Applicable: SharePoint Online

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

Applicable: SharePoint Online

The display name of the site design.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version

Applicable: SharePoint Online

The new version number of the site design.

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind

OUTPUTS

System.Object

NOTES

RELATED LINKS