Skip to content

Commit 7e4dbe0

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#1836 from erwinvanhunen/master
added/updated new cmdlets for October 2018 Release
2 parents e2e6f95 + 4e8349e commit 7e4dbe0

38 files changed

+1874
-44
lines changed

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ Cmdlet|Description|Platform
113113
**[Get‑PnPConnection](../../sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
114114
**[Get‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Get-PnPContext.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
115115
**[Set‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Set-PnPContext.md)** |Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
116+
**[Get‑PnPException](../../sharepoint-ps/sharepoint-pnp/Get-PnPException.md)** |Returns the last exception that occured|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
116117
**[Get‑PnPHealthScore](../../sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md)** |Retrieves the healthscore|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
117118
**[Connect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md)** |Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
118119
**[Disconnect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md)** |Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
@@ -249,6 +250,8 @@ Cmdlet|Description|Platform
249250
## Information Management
250251
Cmdlet|Description|Platform
251252
:-----|:----------|:-------
253+
**[Get‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md)** |Gets the label/tag of the specfied list or library (if applicable)|SharePoint Online
254+
**[Set‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md)** |Sets a label/tag on the specified list or library|SharePoint Online
252255
**[Get‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
253256
**[Set‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
254257
**[Get‑PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
@@ -307,12 +310,28 @@ Cmdlet|Description|Platform
307310
**[Add‑PnPFileToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md)** |Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
308311
**[Convert‑PnPFolderToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md)** |Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
309312
**[Add‑PnPListFoldersToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md)** |Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
313+
**[New‑PnPProvisioningCommunicationSite](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningCommunicationSite.md)** |Creates a communication site object|SharePoint Online
314+
**[Apply‑PnPProvisioningHierarchy](../../sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningHierarchy.md)** |Adds a provisioning sequence object to a provisioning site object|SharePoint Online
315+
**[New‑PnPProvisioningHierarchy](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningHierarchy.md)** |Creates a new provisioning hierarchy object|SharePoint Online
316+
**[Read‑PnPProvisioningHierarchy](../../sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningHierarchy.md)** |Loads/Reads a PnP provisioning hierarchy from the file system and returns an in-memory instance of this template.|SharePoint Online
317+
**[Save‑PnPProvisioningHierarchy](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningHierarchy.md)** |Saves a PnP provisioning hierarchy to the file system|SharePoint Online
318+
**[Test‑PnPProvisioningHierarchy](../../sharepoint-ps/sharepoint-pnp/Test-PnPProvisioningHierarchy.md)** |Tests a provisioning hierarchy for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
319+
**[Add‑PnPProvisioningSequence](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSequence.md)** |Adds a provisioning sequence object to a provisioning hierarchy|SharePoint Online
320+
**[Get‑PnPProvisioningSequence](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningSequence.md)** |Returns one ore more provisioning sequence object(s) from a provisioning hierarchy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
321+
**[New‑PnPProvisioningSequence](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningSequence.md)** |Creates a new provisioning sequence object|SharePoint Online
322+
**[Add‑PnPProvisioningSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSite.md)** |Adds a provisioning sequence object to a provisioning hierarchy|SharePoint Online
323+
**[Get‑PnPProvisioningSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningSite.md)** |Returns one ore more provisioning sequence object(s) from a provisioning hierarchy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
324+
**[Add‑PnPProvisioningSubSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSubSite.md)** |Adds a provisioning sequence object to a provisioning site object|SharePoint Online
325+
**[New‑PnPProvisioningTeamNoGroupSite](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTeamNoGroupSite.md)** |Creates a team site without an Office 365 group object|SharePoint Online
326+
**[New‑PnPProvisioningTeamNoGroupSubSite](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTeamNoGroupSubSite.md)** |Creates a team site subsite with no Office 365 group object|SharePoint Online
327+
**[New‑PnPProvisioningTeamSite](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTeamSite.md)** |Creates a team site object|SharePoint Online
328+
**[Add‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md)** |Adds a provisioning template object to a provisioning hierarchy|SharePoint Online
310329
**[Apply‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md)** |Applies a provisioning template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
311330
**[Convert‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md)** |Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
312331
**[Get‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md)** |Generates a provisioning template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
313332
**[New‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md)** |Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
314333
**[Read‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md)** |Loads/Reads a PnP file from the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
315-
**[Save‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md)** |Saves a PnP file to the file systems|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
334+
**[Save‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md)** |Saves a PnP provisioning tempalte to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
316335
**[New‑PnPProvisioningTemplateFromFolder](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md)** |Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
317336
**[Set‑PnPProvisioningTemplateMetadata](../../sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md)** |Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
318337

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This will add a new document set based upon the 'Test Document Set' content type
3030
## PARAMETERS
3131

3232
### -ContentType
33-
The name of the content type, its ID or an actual content object referencing to the document set.
33+
The name of the content type, its ID or an actual content object referencing to the document set
3434

3535
```yaml
3636
Type: ContentTypePipeBind

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Uploads a file to Web
1414
```powershell
1515
Add-PnPFile -Path <String>
1616
-Folder <String>
17+
[-NewFileName <String>]
1718
[-Checkout [<SwitchParameter>]]
1819
[-CheckInComment <String>]
1920
[-Approve [<SwitchParameter>]]
@@ -89,6 +90,13 @@ Add-PnPFile -FileName sample.docx -Folder "Documents" -Values @{Modified="1/1/20
8990

9091
This will add a file sample.docx to the Documents folder and will set the Modified date to 1/1/2016, Created date to 1/1/2017 and the Modified By field to the user with ID 23. To find out about the proper user ID to relate to a specific user, use Get-PnPUser.
9192

93+
### ------------------EXAMPLE 7------------------
94+
```powershell
95+
Add-PnPFile -FileName sample.docx -Folder "Documents" -NewFileName "differentname.docx"
96+
```
97+
98+
This will upload a local file sample.docx to the Documents folder giving it the filename differentname.docx on SharePoint
99+
92100
## PARAMETERS
93101

94102
### -Approve
@@ -175,6 +183,18 @@ Position: Named
175183
Accept pipeline input: False
176184
```
177185
186+
### -NewFileName
187+
Filename to give the file on SharePoint
188+
189+
```yaml
190+
Type: String
191+
Parameter Sets: Upload file
192+
193+
Required: False
194+
Position: Named
195+
Accept pipeline input: False
196+
```
197+
178198
### -Path
179199
The local file path.
180200

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSequence.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
schema: 2.0.0
5+
---
6+
# Add-PnPProvisioningSequence
7+
8+
## SYNOPSIS
9+
Adds a provisioning sequence object to a provisioning hierarchy
10+
11+
## SYNTAX
12+
13+
```powershell
14+
Add-PnPProvisioningSequence -Hierarchy <ProvisioningHierarchy>
15+
-Sequence <ProvisioningSequence>
16+
```
17+
18+
## EXAMPLES
19+
20+
### ------------------EXAMPLE 1------------------
21+
```powershell
22+
Add-PnPProvisioningSequence -Hierarchy $myhierarchy -Sequence $mysequence
23+
```
24+
25+
Adds an existing sequence object to an existing hierarchy object
26+
27+
### ------------------EXAMPLE 2------------------
28+
```powershell
29+
New-PnPProvisioningSequence -Id "MySequence" | Add-PnPProvisioningSequence -Hierarchy $hierarchy
30+
```
31+
32+
Creates a new instance of a provisioning sequence object and sets the Id to the value specified, then the sequence is added to an existing hierarchy object
33+
34+
## PARAMETERS
35+
36+
### -Hierarchy
37+
The hierarchy to add the sequence to
38+
39+
```yaml
40+
Type: ProvisioningHierarchy
41+
Parameter Sets: __AllParameterSets
42+
43+
Required: True
44+
Position: Named
45+
Accept pipeline input: False
46+
```
47+
48+
### -Sequence
49+
Optional Id of the sequence
50+
51+
```yaml
52+
Type: ProvisioningSequence
53+
Parameter Sets: __AllParameterSets
54+
55+
Required: True
56+
Position: Named
57+
Accept pipeline input: True
58+
```
59+
60+
## RELATED LINKS
61+
62+
[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSite.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
schema: 2.0.0
5+
---
6+
# Add-PnPProvisioningSite
7+
8+
## SYNOPSIS
9+
Adds a provisioning sequence object to a provisioning hierarchy
10+
11+
## SYNTAX
12+
13+
```powershell
14+
Add-PnPProvisioningSite -Site <ProvisioningSitePipeBind>
15+
-Sequence <ProvisioningSequence>
16+
```
17+
18+
## EXAMPLES
19+
20+
### ------------------EXAMPLE 1------------------
21+
```powershell
22+
Add-PnPProvisioningSite -Site $myteamsite -Sequence $mysequence
23+
```
24+
25+
Adds an existing site object to an existing hierarchy sequence
26+
27+
## PARAMETERS
28+
29+
### -Sequence
30+
The sequence to add the site to
31+
32+
```yaml
33+
Type: ProvisioningSequence
34+
Parameter Sets: (All)
35+
36+
Required: True
37+
Position: Named
38+
Accept pipeline input: True
39+
```
40+
41+
### -Site
42+
43+
44+
```yaml
45+
Type: ProvisioningSitePipeBind
46+
Parameter Sets: (All)
47+
48+
Required: True
49+
Position: Named
50+
Accept pipeline input: True
51+
```
52+
53+
## RELATED LINKS
54+
55+
[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningSubSite.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
schema: 2.0.0
5+
---
6+
# Add-PnPProvisioningSubSite
7+
8+
## SYNOPSIS
9+
Adds a provisioning sequence object to a provisioning site object
10+
11+
## SYNTAX
12+
13+
```powershell
14+
Add-PnPProvisioningSubSite -SubSite <TeamNoGroupSubSite>
15+
-Site <SiteCollection>
16+
```
17+
18+
## EXAMPLES
19+
20+
### ------------------EXAMPLE 1------------------
21+
```powershell
22+
Add-PnPProvisioningSubSite -Site $mysite -SubSite $mysubsite
23+
```
24+
25+
Adds an existing subsite object to an existing hierarchy sequence site object
26+
27+
## PARAMETERS
28+
29+
### -Site
30+
The site to add the subsite to
31+
32+
```yaml
33+
Type: SiteCollection
34+
Parameter Sets: (All)
35+
36+
Required: True
37+
Position: Named
38+
Accept pipeline input: True
39+
```
40+
41+
### -SubSite
42+
The subsite to add
43+
44+
```yaml
45+
Type: TeamNoGroupSubSite
46+
Parameter Sets: (All)
47+
48+
Required: True
49+
Position: Named
50+
Accept pipeline input: False
51+
```
52+
53+
## RELATED LINKS
54+
55+
[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)

‎sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
schema: 2.0.0
5+
---
6+
# Add-PnPProvisioningTemplate
7+
8+
## SYNOPSIS
9+
Adds a provisioning template object to a provisioning hierarchy
10+
11+
## SYNTAX
12+
13+
```powershell
14+
Add-PnPProvisioningTemplate -Template <ProvisioningTemplate>
15+
-Hierarchy <ProvisioningHierarchy>
16+
```
17+
18+
## EXAMPLES
19+
20+
### ------------------EXAMPLE 1------------------
21+
```powershell
22+
Add-PnPProvisioningTemplate -Hierarchy $myhierarchy -Template $mytemplate
23+
```
24+
25+
Adds an existing sequence object to an existing hierarchy object
26+
27+
## PARAMETERS
28+
29+
### -Hierarchy
30+
The hierarchy to add the template to
31+
32+
```yaml
33+
Type: ProvisioningHierarchy
34+
Parameter Sets: (All)
35+
36+
Required: True
37+
Position: Named
38+
Accept pipeline input: True
39+
```
40+
41+
### -Template
42+
The template to add to the hierarchy
43+
44+
```yaml
45+
Type: ProvisioningTemplate
46+
Parameter Sets: (All)
47+
48+
Required: True
49+
Position: Named
50+
Accept pipeline input: False
51+
```
52+
53+
## RELATED LINKS
54+
55+
[SharePoint Developer Patterns and Practices](http://aka.ms/sppnp)

0 commit comments

Comments
 (0)