Skip to content

Commit a7f8a97

Browse files
committed
Merge branch 'master' into chrisda
2 parents 1a28b2f + 0a77832 commit a7f8a97

34 files changed

+1252
-296
lines changed

exchange/exchange-ps/exchange/mailboxes/Get-MailboxLocation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,4 @@ To see the return types, which are also known as output types, that this cmdlet
208208
209209
## RELATED LINKS
210210
211-
[Online Version](https://technet.microsoft.com/library/b6393122-1556-4b0b-b80d-c7737b09eb9c.aspx)
211+
[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/get-mailboxlocation)

sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PnP PowerShell overview
22

3-
SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises.
3+
SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online and SharePoint On-Premises.
44

55
![SharePoint Patterns and Practices](https://devofficecdn.azureedge.net/media/Default/PnP/sppnp.png)
66

sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Associates a site with a hub site.
1313
## SYNTAX
1414

1515
```
16-
Add-SPOHubSiteAssociation [-Site] <SpoSitePipeBind> `
16+
Add-SPOHubSiteAssociation [-Site] <SpoSitePipeBind>
1717
-HubSite <SpoHubSitePipeBind> `
1818
[<CommonParameters>]
1919
```
@@ -26,7 +26,7 @@ Use this cmdlet to associate a site with a hub site.
2626
### Example 1
2727

2828
```
29-
Add-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research `
29+
Add-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research
3030
-HubSite https://contoso.sharepoint.com/sites/Marketing
3131
```
3232

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
applicable: SharePoint Online
3+
title: Add-SPOSiteDesignTask
4+
schema: 2.0.0
5+
---
6+
7+
# Add-SPOSiteDesignTask
8+
9+
## SYNOPSIS
10+
11+
Similar to Invoke-SPOSiteDesign, this command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions).
12+
13+
The supported site templates you can apply a site design to include: “modern” team site (with O365 group), “modern” team site (without an O365 group); communication site; classic team site; and classic publishing site.
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Add-SPOSiteDesignTask
19+
-SiteDesignId <guid>
20+
-WebUrl <string>
21+
[<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions).
27+
28+
This command is intended to replace Invoke-SPOSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts.
29+
30+
> [!NOTE]
31+
> This command only creates the request. To check on the job status or to view details of the scheduled run, use the commands in the related section below.
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
37+
This example applies a site design that includes two site scripts - totaling over 30 site script actions. Executing the commands will schedule the site design to be queued and run against the designated site collection.
38+
39+
```powershell
40+
Add-SPOSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome”
41+
```
42+
43+
## PARAMETERS
44+
45+
### -SiteDesignId
46+
The ID of the site design to apply.
47+
48+
```yaml
49+
Type: SPOSiteDesignPipeBind
50+
Parameter Sets: (All)
51+
Aliases:
52+
Applicable: SharePoint Online
53+
Required: True
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -WebUrl
61+
The URL of the site collection where the site design will be applied.
62+
63+
```yaml
64+
Type: String
65+
Parameter Sets: (All)
66+
Aliases:
67+
Applicable: SharePoint Online
68+
Required: True
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
## RELATED COMMANDS
75+
76+
- [Get-SPOSiteDesignTask](https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/get-spositedesigntask?view=sharepoint-ps)
77+
78+
- [Invoke-SPOSiteDesign](https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/invoke-spositedesign?view=sharepoint-ps)
79+
80+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Get-SPOSiteScriptFromList
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOSiteScriptFromList
9+
10+
## SYNOPSIS
11+
12+
Creates site script syntax from an existing SharePoint list.
13+
14+
## SYNTAX
15+
16+
```powershell
17+
Get-SPOSiteScriptFromList
18+
-ListUrl <string>
19+
[<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Uses an existing SharePoint list to output a JSON blob that can be used to create a site script for use in a site design.
25+
26+
[!NOTE]
27+
Most column data types and list configurations - including view formatting - are supported. Managed metadata fields cannot be extracted at this time.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
This example creates the site script output from an existing list - and writes it to a variable. This variable is then referenced to create a site script.
34+
35+
```powershell
36+
C:\> $extracted = Get-SPOSiteScriptFromList -ListUrl "https://contoso.sharepoint.com/sites/strategy/customer-contacts"
37+
C:\> Add-SPOSiteScript `
38+
-Title "Contoso Customer Tracker"
39+
-Description "This creates a customer contact list"
40+
-Content $extracted
41+
```
42+
43+
## PARAMETERS
44+
45+
### -ListUrl
46+
The url of the list to be referenced for the JSON output.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: (All)
51+
Aliases:
52+
Applicable: SharePoint Online
53+
Required: True
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
applicable: SharePoint Online
4+
title: Remove-SPOSiteDesignTask
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPOSiteDesignTask
9+
10+
## SYNOPSIS
11+
12+
Command to remove a scheduled site design script.
13+
14+
## SYNTAX
15+
16+
```powershell
17+
Remove-SPOSiteDesignTask
18+
-Identity <guid>
19+
[<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Removes a scheduled site design by providing the site design ID. If the execution of the associated site script has already started the execution will not be terminated.
25+
26+
> [!NOTE]
27+
> This command only removes a scheduled request. To check on the job status or to view details of the scheduled run, use the commands in the related section below.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
This example removes a previously scheduled site design.
34+
35+
```powershell
36+
Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82
37+
```
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The ID of the site design to apply.
43+
44+
```yaml
45+
Type: SPOSiteDesignPipeBind
46+
Parameter Sets: (All)
47+
Aliases:
48+
Applicable: SharePoint Online
49+
Required: True
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
## RELATED LINKS
57+
58+
[Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md)
59+
60+
[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md)
61+
62+
[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md)

sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ The following cmdlet references are for SharePoint Online.
2222
### [Add-SPOSiteDesign](Add-SPOSiteDesign.md)
2323
{{Manually Enter Add-SPOSiteDesign Description Here}}
2424

25+
### [Add-SPOSiteDesign](Add-SPOSiteDesignTask.md)
26+
{{Manually Enter Add-SPOSiteDesignTask Description Here}}
27+
2528
### [Add-SPOSiteScript](Add-SPOSiteScript.md)
2629
{{Manually Enter Add-SPOSiteScript Description Here}}
2730

@@ -118,15 +121,27 @@ The following cmdlet references are for SharePoint Online.
118121
### [Get-SPOSiteDesign](Get-SPOSiteDesign.md)
119122
{{Manually Enter Get-SPOSiteDesign Description Here}}
120123

124+
### [Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md)
125+
{{Manually Enter Get-SPOSiteDesignRights Description Here}}
126+
127+
### [Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md)
128+
{{Manually Enter Get-SPOSiteDesignRights Description Here}}
129+
121130
### [Get-SPOSiteDesignRights](Get-SPOSiteDesignRights.md)
122131
{{Manually Enter Get-SPOSiteDesignRights Description Here}}
123132

133+
### [Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md)
134+
{{Manually Enter Add-SPOSiteDesign Description Here}}
135+
124136
### [Get-SPOSiteGroup](Get-SPOSiteGroup.md)
125137
{{Manually Enter Get-SPOSiteGroup Description Here}}
126138

127139
### [Get-SPOSiteScript](Get-SPOSiteScript.md)
128140
{{Manually Enter Get-SPOSiteScript Description Here}}
129141

142+
### [Get-SPOSiteScriptFromList](Get-SPOSiteScriptFromList.md)
143+
{{Manually Enter Get-SPOSiteScript Description Here}}
144+
130145
### [Get-SPOTenant](Get-SPOTenant.md)
131146
{{Manually Enter Get-SPOTenant Description Here}}
132147

@@ -244,6 +259,9 @@ The following cmdlet references are for SharePoint Online.
244259
### [Remove-SPOSiteDesign](Remove-SPOSiteDesign.md)
245260
{{Manually Enter Remove-SPOSiteDesign Description Here}}
246261

262+
### [Remove-SPOSiteDesignTask](Remove-SPOSiteDesignTask.md)
263+
{{Manually Enter Remove-SPOSiteDesign Description Here}}
264+
247265
### [Remove-SPOSiteGroup](Remove-SPOSiteGroup.md)
248266
{{Manually Enter Remove-SPOSiteGroup Description Here}}
249267

@@ -368,4 +386,4 @@ The following cmdlet references are for SharePoint Online.
368386
{{Manually Enter Upgrade-SPOSite Description Here}}
369387

370388

371-
<!--updated March 6, 2018; moved cmdlets from https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-powershell; added items from TOC that were missing on this page-->
389+
<!--updated March 6, 2018; moved cmdlets from https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-powershell; added items from TOC that were missing on this page-->

0 commit comments

Comments
 (0)