Skip to content

Commit dd582ee

Browse files
KoenZomersVesaJuvonen
authored andcommitted
Creating documentation on using SPO Site Scripts & Designs with PnP PowerShell (SharePoint#5167)
1 parent 06a2685 commit dd582ee

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: SharePoint site design - PnP PowerShell cmdlets
3+
description: Use PnP PowerShell cmdlets to create, retrieve, and remove site designs and site scripts.
4+
ms.date: 01/18/2019
5+
localization_priority: Priority
6+
---
7+
8+
# SharePoint site design: PnP PowerShell cmdlets
9+
10+
Use PnP PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.
11+
12+
## Getting started
13+
14+
To run the PnP PowerShell cmdlets, you'll need to do the following:
15+
16+
1. Download and install the PnP PowerShell Module by running:
17+
18+
```PowerShell
19+
Install-Module SharePointPnPPowerShellOnline
20+
```
21+
22+
2. Connect to the SharePoint Online Admin Center of your tenant:
23+
24+
```PowerShell
25+
Connect-PnPOnline -Url https://tenant-admin.sharepoint.com -UseWebLogin
26+
```
27+
28+
To verify your setup and connection, try using the `Get-PnPSiteScript` cmdlet to read the current list of site scripts. If the cmdlet runs and returns with no errors, you're ready to proceed.
29+
30+
## Site design cmdlets
31+
32+
The following cmdlets are available for managing site designs and site scripts from PnP PowerShell:
33+
34+
- [Add-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteDesign?view=sharepoint-ps)
35+
- [Add-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteDesignTask?view=sharepoint-ps)
36+
- [Add-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteScript?view=sharepoint-ps)
37+
- [Get-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesign?view=sharepoint-ps)
38+
- [Get-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRights?view=sharepoint-ps)
39+
- [Get-PnPSiteDesignRun](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRun?view=sharepoint-ps)
40+
- [Get-PnPSiteDesignRunStatus](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRunStatus?view=sharepoint-ps)
41+
- [Get-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignTask?view=sharepoint-ps)
42+
- [Get-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteScript?view=sharepoint-ps)
43+
- [Grant-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Grant-PnPSiteDesignRights?view=sharepoint-ps)
44+
- [Invoke-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Invoke-PnPSiteDesign?view=sharepoint-ps)
45+
- [Remove-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteDesign?view=sharepoint-ps)
46+
- [Remove-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteDesignTask?view=sharepoint-ps)
47+
- [Remove-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteScript?view=sharepoint-ps)
48+
- [Revoke-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Revoke-PnPSiteDesignRights?view=sharepoint-ps)
49+
- [Set-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Set-PnPSiteDesign?view=sharepoint-ps)
50+
- [Set-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Set-PnPSiteScript?view=sharepoint-ps)
51+
52+
53+
## See also
54+
55+
- [JSON schema reference](site-design-json-schema.md)
56+
- [REST API](site-design-rest-api.md)
57+
- [Apply a scope to your site design](site-design-scoping.md)
58+
- [SharePoint site design and site script overview](site-design-overview.md)
59+
- [SharePoint site design - SharePoint Online Management Shell PowerShell commands](site-design-powershell.md)
60+
- [SharePoint site design - Office 365 CLI commands](site-design-o365cli.md)

0 commit comments

Comments
 (0)