Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
948 changes: 483 additions & 465 deletions sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Adds an alert for a user to a list

## SYNTAX
## SYNTAX

```powershell
Add-PnPAlert -List <ListPipeBind>
Expand Down Expand Up @@ -196,4 +196,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Add/uploads an available app to the app catalog

## SYNTAX
## SYNTAX

### Add only
```powershell
Expand Down Expand Up @@ -161,4 +161,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
---
external help file:
online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpapplicationcustomizer
applicable: SharePoint Online, SharePoint 2019
schema: 2.0.0
---

# Add-PnPApplicationCustomizer

## SYNOPSIS
Adds a SharePoint Framework client side extension application customizer

## SYNTAX

```powershell
Add-PnPApplicationCustomizer -ClientSideComponentId <GuidPipeBind>
[-Title <String>]
[-Description <String>]
[-Sequence <Int>]
[-Scope <CustomActionScope>]
[-ClientSideComponentProperties <String>]
[-ClientSideHostProperties <String>]
[-Web <WebPipeBind>]
[-Connection <SPOnlineConnection>]
```

## DESCRIPTION
Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection

## EXAMPLES

### ------------------EXAMPLE 1------------------
```powershell
Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}
```

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.

## PARAMETERS

### -ClientSideComponentId
The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: GuidPipeBind
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False
```

### -ClientSideComponentProperties
The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -ClientSideHostProperties
The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"

Only applicable to: SharePoint Online

```yaml
Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Description
The description of the application customizer

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Scope
The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: CustomActionScope
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Sequence
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.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: Int
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Title
The title of the application customizer

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Connection
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.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

### -Web
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.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False
```

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
11 changes: 9 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Adds a Client-Side Page

## SYNTAX
## SYNTAX

```powershell
Add-PnPClientSidePage -Name <String>
Expand Down Expand Up @@ -46,6 +46,13 @@ Add-PnPClientSidePage -Name "NewPageTemplate" -PromoteAs Template

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

### ------------------EXAMPLE 4------------------
```powershell
Add-PnPClientSidePage -Name "Folder/NewPage"
```

Creates a new Client-Side page named 'NewPage' under 'Folder' folder and saves as a template to the site.

## PARAMETERS

### -CommentsEnabled
Expand Down Expand Up @@ -162,4 +169,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Adds a new section to a Client-Side page

## SYNTAX
## SYNTAX

```powershell
Add-PnPClientSidePageSection -Page <ClientSidePagePipeBind>
Expand Down Expand Up @@ -141,4 +141,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Adds a text element to a client-side page.

## SYNTAX
## SYNTAX

### Default
```powershell
Expand Down Expand Up @@ -146,4 +146,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file:
online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpclientsidewebpart
applicable: SharePoint Online
applicable: SharePoint Online, SharePoint 2019
schema: 2.0.0
---

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

## SYNTAX
## SYNTAX

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

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: Int
Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part
Expand All @@ -99,6 +101,8 @@ Accept pipeline input: False
### -Component
Specifies the component instance or Id to add.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: ClientSideComponentPipeBind
Parameter Sets: Default with 3rd party web part, Positioned with 3rd party web part
Expand All @@ -111,6 +115,8 @@ Accept pipeline input: False
### -DefaultWebPartType
Defines a default web part type to insert.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: DefaultClientSideWebParts
Parameter Sets: Default with built-in web part, Positioned with built-in web part
Expand All @@ -123,6 +129,8 @@ Accept pipeline input: False
### -Order
Sets the order of the web part control. (Default = 1)

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: Int
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
Expand All @@ -135,6 +143,8 @@ Accept pipeline input: False
### -Page
The name of the page.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: ClientSidePagePipeBind
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
Expand All @@ -147,6 +157,8 @@ Accept pipeline input: True
### -Section
Sets the section where to insert the web part control.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: Int
Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part
Expand All @@ -159,6 +171,8 @@ Accept pipeline input: False
### -WebPartProperties
The properties of the web part

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: PropertyBagPipeBind
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
Expand All @@ -171,6 +185,8 @@ Accept pipeline input: False
### -Connection
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.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: SPOnlineConnection
Parameter Sets: (All)
Expand All @@ -183,6 +199,8 @@ Accept pipeline input: False
### -Web
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.

Only applicable to: SharePoint Online, SharePoint Server 2019

```yaml
Type: WebPipeBind
Parameter Sets: (All)
Expand All @@ -194,4 +212,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ schema: 2.0.0
## SYNOPSIS
Adds a new content type

## SYNTAX
## SYNTAX

```powershell
Add-PnPContentType -Name <String>
Expand Down Expand Up @@ -123,4 +123,4 @@ Accept pipeline input: False

## RELATED LINKS

[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)
Loading