Skip to content

Commit b356460

Browse files
erwinvanhunenerwinvanhunen
committed
JAN 2020 Update
1 parent 22896a3 commit b356460

File tree

404 files changed

+4826
-1423
lines changed

Some content is hidden

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

404 files changed

+4826
-1423
lines changed

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

Lines changed: 483 additions & 465 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds an alert for a user to a list
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
```powershell
1616
Add-PnPAlert -List <ListPipeBind>
@@ -196,4 +196,4 @@ Accept pipeline input: False
196196
197197
## RELATED LINKS
198198
199-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
199+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Add/uploads an available app to the app catalog
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
### Add only
1616
```powershell
@@ -161,4 +161,4 @@ Accept pipeline input: False
161161
162162
## RELATED LINKS
163163
164-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
164+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
---
2+
external help file:
3+
online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpapplicationcustomizer
4+
applicable: SharePoint Online, SharePoint 2019
5+
schema: 2.0.0
6+
---
7+
8+
# Add-PnPApplicationCustomizer
9+
10+
## SYNOPSIS
11+
Adds a SharePoint Framework client side extension application customizer
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Add-PnPApplicationCustomizer -ClientSideComponentId <GuidPipeBind>
17+
[-Title <String>]
18+
[-Description <String>]
19+
[-Sequence <Int>]
20+
[-Scope <CustomActionScope>]
21+
[-ClientSideComponentProperties <String>]
22+
[-ClientSideHostProperties <String>]
23+
[-Web <WebPipeBind>]
24+
[-Connection <SPOnlineConnection>]
25+
```
26+
27+
## DESCRIPTION
28+
Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection
29+
30+
## EXAMPLES
31+
32+
### ------------------EXAMPLE 1------------------
33+
```powershell
34+
Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}
35+
```
36+
37+
Adds a new application customizer to the current web. This requires that a SharePoint Framework solution has been deployed containing the application customizer specified in its manifest. Be sure to run Install-PnPApp before trying this cmdlet on a site.
38+
39+
## PARAMETERS
40+
41+
### -ClientSideComponentId
42+
The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest
43+
44+
Only applicable to: SharePoint Online, SharePoint Server 2019
45+
46+
```yaml
47+
Type: GuidPipeBind
48+
Parameter Sets: (All)
49+
50+
Required: True
51+
Position: Named
52+
Accept pipeline input: False
53+
```
54+
55+
### -ClientSideComponentProperties
56+
The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"
57+
58+
Only applicable to: SharePoint Online, SharePoint Server 2019
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
64+
Required: False
65+
Position: Named
66+
Accept pipeline input: False
67+
```
68+
69+
### -ClientSideHostProperties
70+
The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"
71+
72+
Only applicable to: SharePoint Online
73+
74+
```yaml
75+
Type: String
76+
Parameter Sets: (All)
77+
78+
Required: False
79+
Position: Named
80+
Accept pipeline input: False
81+
```
82+
83+
### -Description
84+
The description of the application customizer
85+
86+
Only applicable to: SharePoint Online, SharePoint Server 2019
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
92+
Required: False
93+
Position: Named
94+
Accept pipeline input: False
95+
```
96+
97+
### -Scope
98+
The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.
99+
100+
Only applicable to: SharePoint Online, SharePoint Server 2019
101+
102+
```yaml
103+
Type: CustomActionScope
104+
Parameter Sets: (All)
105+
106+
Required: False
107+
Position: Named
108+
Accept pipeline input: False
109+
```
110+
111+
### -Sequence
112+
Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.
113+
114+
Only applicable to: SharePoint Online, SharePoint Server 2019
115+
116+
```yaml
117+
Type: Int
118+
Parameter Sets: (All)
119+
120+
Required: False
121+
Position: Named
122+
Accept pipeline input: False
123+
```
124+
125+
### -Title
126+
The title of the application customizer
127+
128+
Only applicable to: SharePoint Online, SharePoint Server 2019
129+
130+
```yaml
131+
Type: String
132+
Parameter Sets: (All)
133+
134+
Required: False
135+
Position: Named
136+
Accept pipeline input: False
137+
```
138+
139+
### -Connection
140+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
141+
142+
Only applicable to: SharePoint Online, SharePoint Server 2019
143+
144+
```yaml
145+
Type: SPOnlineConnection
146+
Parameter Sets: (All)
147+
148+
Required: False
149+
Position: Named
150+
Accept pipeline input: False
151+
```
152+
153+
### -Web
154+
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.
155+
156+
Only applicable to: SharePoint Online, SharePoint Server 2019
157+
158+
```yaml
159+
Type: WebPipeBind
160+
Parameter Sets: (All)
161+
162+
Required: False
163+
Position: Named
164+
Accept pipeline input: False
165+
```
166+
167+
## RELATED LINKS
168+
169+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds a Client-Side Page
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
```powershell
1616
Add-PnPClientSidePage -Name <String>
@@ -46,6 +46,13 @@ Add-PnPClientSidePage -Name "NewPageTemplate" -PromoteAs Template
4646

4747
Creates a new Client-Side page named 'NewPage' and saves as a template to the site.
4848

49+
### ------------------EXAMPLE 4------------------
50+
```powershell
51+
Add-PnPClientSidePage -Name "Folder/NewPage"
52+
```
53+
54+
Creates a new Client-Side page named 'NewPage' under 'Folder' folder and saves as a template to the site.
55+
4956
## PARAMETERS
5057

5158
### -CommentsEnabled
@@ -162,4 +169,4 @@ Accept pipeline input: False
162169
163170
## RELATED LINKS
164171
165-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
172+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds a new section to a Client-Side page
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
```powershell
1616
Add-PnPClientSidePageSection -Page <ClientSidePagePipeBind>
@@ -141,4 +141,4 @@ Accept pipeline input: False
141141
142142
## RELATED LINKS
143143
144-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
144+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds a text element to a client-side page.
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
### Default
1616
```powershell
@@ -146,4 +146,4 @@ Accept pipeline input: False
146146
147147
## RELATED LINKS
148148
149-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
149+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpclientsidewebpart
4-
applicable: SharePoint Online
4+
applicable: SharePoint Online, SharePoint 2019
55
schema: 2.0.0
66
---
77

@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds a Client-Side Web Part to a client-side page
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
### Default with built-in web part
1616
```powershell
@@ -87,6 +87,8 @@ Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' in section
8787
### -Column
8888
Sets the column where to insert the web part control.
8989

90+
Only applicable to: SharePoint Online, SharePoint Server 2019
91+
9092
```yaml
9193
Type: Int
9294
Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part
@@ -99,6 +101,8 @@ Accept pipeline input: False
99101
### -Component
100102
Specifies the component instance or Id to add.
101103
104+
Only applicable to: SharePoint Online, SharePoint Server 2019
105+
102106
```yaml
103107
Type: ClientSideComponentPipeBind
104108
Parameter Sets: Default with 3rd party web part, Positioned with 3rd party web part
@@ -111,6 +115,8 @@ Accept pipeline input: False
111115
### -DefaultWebPartType
112116
Defines a default web part type to insert.
113117
118+
Only applicable to: SharePoint Online, SharePoint Server 2019
119+
114120
```yaml
115121
Type: DefaultClientSideWebParts
116122
Parameter Sets: Default with built-in web part, Positioned with built-in web part
@@ -123,6 +129,8 @@ Accept pipeline input: False
123129
### -Order
124130
Sets the order of the web part control. (Default = 1)
125131
132+
Only applicable to: SharePoint Online, SharePoint Server 2019
133+
126134
```yaml
127135
Type: Int
128136
Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part
@@ -135,6 +143,8 @@ Accept pipeline input: False
135143
### -Page
136144
The name of the page.
137145
146+
Only applicable to: SharePoint Online, SharePoint Server 2019
147+
138148
```yaml
139149
Type: ClientSidePagePipeBind
140150
Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part
@@ -147,6 +157,8 @@ Accept pipeline input: True
147157
### -Section
148158
Sets the section where to insert the web part control.
149159
160+
Only applicable to: SharePoint Online, SharePoint Server 2019
161+
150162
```yaml
151163
Type: Int
152164
Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part
@@ -159,6 +171,8 @@ Accept pipeline input: False
159171
### -WebPartProperties
160172
The properties of the web part
161173
174+
Only applicable to: SharePoint Online, SharePoint Server 2019
175+
162176
```yaml
163177
Type: PropertyBagPipeBind
164178
Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part
@@ -171,6 +185,8 @@ Accept pipeline input: False
171185
### -Connection
172186
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
173187
188+
Only applicable to: SharePoint Online, SharePoint Server 2019
189+
174190
```yaml
175191
Type: SPOnlineConnection
176192
Parameter Sets: (All)
@@ -183,6 +199,8 @@ Accept pipeline input: False
183199
### -Web
184200
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.
185201
202+
Only applicable to: SharePoint Online, SharePoint Server 2019
203+
186204
```yaml
187205
Type: WebPipeBind
188206
Parameter Sets: (All)
@@ -194,4 +212,4 @@ Accept pipeline input: False
194212
195213
## RELATED LINKS
196214
197-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
215+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ schema: 2.0.0
1010
## SYNOPSIS
1111
Adds a new content type
1212

13-
## SYNTAX
13+
## SYNTAX
1414

1515
```powershell
1616
Add-PnPContentType -Name <String>
@@ -123,4 +123,4 @@ Accept pipeline input: False
123123
124124
## RELATED LINKS
125125
126-
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
126+
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)

0 commit comments

Comments
 (0)