Skip to content

Commit 96e5989

Browse files
authored
Merge pull request MicrosoftDocs#143 from erwinvanhunen/master
SharePoint PnP PowerShell Documentation updates
2 parents fbcb895 + 3cd359f commit 96e5989

File tree

203 files changed

+3248
-329
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

203 files changed

+3248
-329
lines changed

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

Lines changed: 104 additions & 51 deletions
Large diffs are not rendered by default.

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,19 @@ Add/uploads an available app to the app catalog
1010

1111
## SYNTAX
1212

13+
### Add only
1314
```powershell
1415
Add-PnPApp -Path <String>
16+
[-Overwrite [<SwitchParameter>]]
17+
[-Connection <SPOnlineConnection>]
18+
```
19+
20+
### Add and Publish
21+
```powershell
22+
Add-PnPApp -Publish [<SwitchParameter>]
23+
-Path <String>
24+
[-SkipFeatureDeployment [<SwitchParameter>]]
25+
[-Overwrite [<SwitchParameter>]]
1526
[-Connection <SPOnlineConnection>]
1627
```
1728

@@ -24,20 +35,63 @@ PS:> Add-PnPApp -Path ./myapp.sppkg
2435

2536
This will upload the specified app package to the app catalog
2637

38+
### ------------------EXAMPLE 2------------------
39+
```powershell
40+
PS:> Add-PnPApp -Path ./myapp.sppkg -Publish
41+
```
42+
43+
This will upload the specified app package to the app catalog and deploy/trust it at the same time.
44+
2745
## PARAMETERS
2846

47+
### -Overwrite
48+
Overwrites the existing app package if it already exists
49+
50+
```yaml
51+
Type: SwitchParameter
52+
Parameter Sets: (All)
53+
54+
Required: False
55+
Position: Named
56+
Accept pipeline input: False
57+
```
58+
2959
### -Path
3060
Specifies the Id or an actual app metadata instance
3161
3262
```yaml
3363
Type: String
34-
Parameter Sets: (All)
64+
Parameter Sets: Add only
3565

3666
Required: True
3767
Position: 0
3868
Accept pipeline input: True
3969
```
4070
71+
### -Publish
72+
This will deploy/trust an app into the app catalog
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: Add and Publish
77+
78+
Required: True
79+
Position: Named
80+
Accept pipeline input: False
81+
```
82+
83+
### -SkipFeatureDeployment
84+
85+
86+
```yaml
87+
Type: SwitchParameter
88+
Parameter Sets: Add and Publish
89+
90+
Required: False
91+
Position: Named
92+
Accept pipeline input: False
93+
```
94+
4195
### -Connection
4296
Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
4397

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Accept pipeline input: False
124124
```
125125
126126
### -Web
127-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
127+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
128128
129129
```yaml
130130
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Accept pipeline input: False
9393
```
9494
9595
### -Web
96-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
96+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
9797
9898
```yaml
9999
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Accept pipeline input: False
117117
```
118118
119119
### -Web
120-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
120+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
121121
122122
```yaml
123123
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Accept pipeline input: False
179179
```
180180
181181
### -Web
182-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
182+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
183183
184184
```yaml
185185
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Accept pipeline input: False
104104
```
105105
106106
### -Web
107-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
107+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
108108
109109
```yaml
110110
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This will add the content type called 'Test CT' to the document set called ''Tes
2929
### ------------------EXAMPLE 2------------------
3030
```powershell
3131
PS:> $docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set"
32-
PS:> $ct = Get-SPOContentType -Identity "Test CT"
32+
PS:> $ct = Get-PnPContentType -Identity "Test CT"
3333
PS:> Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset
3434
```
3535

@@ -81,7 +81,7 @@ Accept pipeline input: False
8181
```
8282
8383
### -Web
84-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
84+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
8585
8686
```yaml
8787
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Accept pipeline input: False
7878
```
7979
8080
### -Web
81-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
81+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
8282
8383
```yaml
8484
Type: WebPipeBind

sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Accept pipeline input: False
252252
```
253253
254254
### -Web
255-
The GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
255+
This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.
256256
257257
```yaml
258258
Type: WebPipeBind

0 commit comments

Comments
 (0)