Skip to content

Commit d21a594

Browse files
authored
Update site-design-powershell.md
Updated details on Set-SPOSiteDesign update cmdlet
1 parent fe77258 commit d21a594

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

docs/declarative-customization/site-design-powershell.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ The following cmdlets are available for managing site designs and site scripts f
3333
- **Remove-SPOSiteDesign**
3434
- **Remove-SPOSiteScript**
3535
- **Revoke-SPOSiteDesignRights**
36-
<!--
3736
- **Set-SPOSiteDesign**
37+
38+
<!--
3839
- **Set-SPOSiteScript**
3940
-->
4041

@@ -80,7 +81,7 @@ C:\> Add-SPOSiteDesign `
8081
-PreviewImageAltText "site preview"
8182
```
8283

83-
## **Add-SPOSiteScript**
84+
## Add-SPOSiteScript
8485

8586
Uploads a new site script for use either directly or in a site design.
8687

@@ -309,6 +310,47 @@ Updates a previously uploaded site design.
309310
Updates a previously uploaded site script.
310311
-->
311312

313+
## Set-SPOSiteDesign
314+
315+
Updates a previously uploaded site design.
316+
317+
```powershell
318+
Set-SPOSiteDesign
319+
-Identity <SPOSiteDesignPipeBind[]>
320+
[-Title <string>]
321+
[-WebTemplate <string>]
322+
[-SiteScripts <SPOSiteScriptPipeBind[]>]
323+
[-Description <string>]
324+
[-PreviewImageUrl <string>]
325+
[-PreviewImageAltText <string>]
326+
[-IsDefault]
327+
[<CommonParameters>]
328+
```
329+
330+
### Parameters
331+
332+
|Parameter | Description |
333+
|-----------|--------------|
334+
|-Title | The display name of the site design. |
335+
|-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. |
336+
|-SiteScripts | An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed. |
337+
|[-Description] | The display description of site design. |
338+
|[-PreviewImageUrl] | The URL of a preview image. If none is specified SharePoint will use a generic image. |
339+
|[-PreviewImageAltText] | The alt text description of the image for accessibility. |
340+
|[-IsDefault] | A switch that if provided, applies the site design to the default site template. For more information see [Customize a default site design](customize-default-site-design.md) |
341+
342+
The following example updates a previously created site design.
343+
344+
```powershell
345+
C:\> Set-SPOSiteDesign `
346+
-Title "Contoso customer tracking - version 2" `
347+
-WebTemplate "68" `
348+
-Description "Updated site design for list schema that tracks key customer data in a list" `
349+
-PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" `
350+
-PreviewImageAltText "site preview - version 2"
351+
```
352+
353+
312354
## See also
313355

314356
- [JSON schema reference](site-design-json-schema.md)

0 commit comments

Comments
 (0)