Skip to content

Commit e23ea56

Browse files
authored
Update site-design-powershell.md
Updated w/ details on Invoke-SPOSiteDesign cmdlet (released in Feb 2018)
1 parent b411053 commit e23ea56

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

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

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ ms.date: 01/08/2018
77
# PowerShell cmdlets for SharePoint site designs and site scripts
88

99
> [!NOTE]
10-
> Site designs and site scripts are in preview and are subject to change. They are currently only supported for use in production environments in Targeted Release.
10+
> Site designs and site scripts have been released to production and are available for general use.
1111
12-
Use PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts.
12+
Use PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.
1313

1414
## Getting started
1515

@@ -30,6 +30,7 @@ The following cmdlets are available for managing site designs and site scripts f
3030
- **Get-SPOSiteDesignRights**
3131
- **Get-SPOSiteScript**
3232
- **Grant-SPOSiteDesignRights**
33+
- **Invoke-SPOSiteDesign**
3334
- **Remove-SPOSiteDesign**
3435
- **Remove-SPOSiteScript**
3536
- **Revoke-SPOSiteDesignRights**
@@ -98,7 +99,7 @@ Add-SPOSiteScript
9899
| -Content | JSON value that describes the script. For more information, see [JSON reference](site-design-json-schema.md).|
99100
| -Description | A description of the script. |
100101

101-
The following example adds a new site from the following script in a file.
102+
The following example adds a new site logo from the following script in a file.
102103

103104
```json
104105
{
@@ -233,6 +234,45 @@ PS C:\> Grant-SPOSiteDesignRights `
233234
-Rights View
234235
```
235236

237+
## Invoke-SPOSiteDesign
238+
239+
Applies a published site design to a specified site collection target. This allows a site design to be applied to an existing site collection.
240+
241+
```powershell
242+
Invoke-SPOSiteDesign
243+
[-Identity]
244+
-WebUrl <string>
245+
[<CommonParameters>]
246+
```
247+
248+
### Parameters
249+
250+
|Parameter | Description |
251+
|--------------|--------------|
252+
| -Identity | The ID of the site design to apply. |
253+
| -WebUrl | The Url of the site collection where the site design will be applied.|
254+
255+
The following example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site.
256+
257+
```powershell
258+
C:\> Invoke-SPOSiteDesign -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectgo”
259+
260+
Title Outcome
261+
---------------------------------------------- -------
262+
Create or update list Project Activities Success
263+
Update list description Success
264+
Create column Project Status Success
265+
Create column Effort (days) Success
266+
Set custom formatter for field Project Status Success
267+
Set custom formatter for field Effort (days) Success
268+
Create or update list Project Collateral Success
269+
Create column Due Date Success
270+
Set custom formatter for field Due Date Success
271+
Add Project Activities to left nav Success
272+
Add Project Collateral to left nav Success
273+
Add to Hub Site Success
274+
```
275+
236276
## Remove-SPOSiteDesign
237277

238278
Removes a site design. It will no longer appear in the UI for creating a new site.

0 commit comments

Comments
 (0)