Skip to content

Commit 2f5d86f

Browse files
VesaJuvonenVesaJuvonen
authored
Merge pull request MicrosoftDocs#1905 from seansquires/patch-4
Create Get-SPOSiteDesignTask
2 parents b927d66 + c82ac94 commit 2f5d86f

File tree

3 files changed

+251
-0
lines changed

3 files changed

+251
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOSiteDesignRun
9+
10+
## SYNOPSIS
11+
Retrieves a list of site designs applied to a specified site collection.
12+
13+
14+
## SYNTAX
15+
16+
```
17+
Get-SPOSiteDesignRun [-WebUrl] <String> [[-SiteDesignId] <SPOSiteDesignPipeBind>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Retrieves a list of site designs applied to a specified site collection. The WebUrl is required to know which site collection to query. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.
22+
23+
## EXAMPLES
24+
25+
### ------------ Example 1 --------------------
26+
27+
This example would return a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design.
28+
29+
```powershell
30+
PS C:\> Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook"
31+
32+
Id: | sean530z-55a3-4804-8b0a-80578626d6ef
33+
SiteDesignId: | sean530b-4133-444e-9e31-fb0c07f69d3a
34+
WebId: | 4f8509cd-7972-44d0-a14a-3c8ad69ee50f
35+
SiteId: | d5d19d7c-sean-4625-9461-281bfc8a9ece
36+
SiteDesignVersion: | 3
37+
SiteDesignTitle: | Contoso Project Playbook
38+
```
39+
40+
## PARAMETERS
41+
42+
### -SiteDesignId
43+
The ID of a specific site design. Use this optional parameter if you wish to only return details on a specific site design run.
44+
45+
```yaml
46+
Type: SPOSiteDesignPipeBind
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: 1
52+
Default value: None
53+
Accept pipeline input: True (ByValue)
54+
Accept wildcard characters: False
55+
```
56+
57+
### -WebUrl
58+
The Url of the site collection.
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: True
66+
Position: 0
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### CommonParameters
73+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
74+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
75+
76+
## INPUTS
77+
78+
### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind
79+
80+
## OUTPUTS
81+
82+
### System.Object
83+
## NOTES
84+
85+
## RELATED LINKS
86+
87+
[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOSiteDesignRunStatus
9+
10+
## SYNOPSIS
11+
Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-SPOSiteDesignRunStatus [-Run] <SPOSiteDesignRun> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
26+
This example gets the run for a specific site design applied to a site and sets it to a variable. This variable is then passed into the command -run parameter. The result is a display of all the site script actions applied for that site design run, including the script action title and outcome.
27+
28+
```powershell
29+
PS C:\> $myrun = Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" -SiteDesignId cefd782e-sean-4814-a68a-b33b116c302f
30+
31+
PS C:\> Get-SPOSiteDesignRunStatus -Run $myrun
32+
33+
OrdinalIndex: | 0
34+
SiteScriptId: | sean530b-4133-444e-9e31-fb0c07f69d3a
35+
SiteScriptTitle: | project tracker script for contoso legal
36+
SiteScriptIndex: | 0
37+
ActionIndex: | 0
38+
ActionTitle: | Add principal contoso legal team to SPGroup Owners.
39+
ActionKey: | 4f8509cd-0000-0000-0000-00000000
40+
OutcomeCode: | Success
41+
OutcomeText: |
42+
43+
OrdinalIndex: | 1
44+
SiteScriptId: | sean530b-4133-444e-9e31-abc123abc123
45+
SiteScriptTitle: | project tracker script for contoso legal
46+
SiteScriptIndex: | 0
47+
ActionIndex: | 1
48+
ActionTitle: | Apply theme Contoso Legal.
49+
ActionKey: | 4f8509cd-0000-0000-0000-00000000
50+
OutcomeCode: | Success
51+
OutcomeText: |
52+
```
53+
54+
## PARAMETERS
55+
56+
### -Run
57+
The site design run for the desired set of script action details.
58+
59+
```yaml
60+
Type: SPOSiteDesignRun
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: True
65+
Position: 0
66+
Default value: None
67+
Accept pipeline input: True (ByValue)
68+
Accept wildcard characters: False
69+
```
70+
71+
### CommonParameters
72+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
73+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
74+
75+
## INPUTS
76+
77+
### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignRun
78+
79+
## OUTPUTS
80+
81+
### System.Object
82+
## NOTES
83+
84+
## RELATED LINKS
85+
86+
[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Add-SPOSiteDesignTask
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOSiteDesignTask
9+
10+
## SYNOPSIS
11+
12+
Cmdlet to get a scheduled site design script.
13+
14+
## SYNTAX
15+
16+
```powershell
17+
Get-SPOSiteDesignTask
18+
-Identity <guid>
19+
-WebUrl <string>
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL fo the SPWeb where the site design is scheduled to be applied.
26+
27+
28+
> [!NOTE]
29+
> This command only retrieves a previously scheduled request.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
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.
36+
37+
```powershell
38+
Get-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome”
39+
```
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
The ID of the scheduled site design to apply.
45+
46+
```yaml
47+
Type: SPOSiteDesignPipeBind
48+
Parameter Sets: (All)
49+
Aliases:
50+
Applicable: SharePoint Online
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -WebUrl
59+
The URL of the site collection where the site design will be applied.
60+
61+
```yaml
62+
Type: String
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: SharePoint Online
66+
Required: True
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
## RELATED LINKS
73+
74+
[Add-SPOSiteDesignTask](Get-SPOSiteDesignTask.md)
75+
76+
[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md)
77+
78+
[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md)

0 commit comments

Comments
 (0)