Skip to content

Commit 0100ce2

Browse files
VesaJuvonenVesaJuvonen
authored
Merge pull request MicrosoftDocs#1222 from erwinvanhunen/master
June 2018 Release documentation updates
2 parents e554b14 + 1c9e515 commit 0100ce2

22 files changed

+336
-33
lines changed

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
title: PnP PowerShell overview
3-
description: Introduction to PnP PowerShell cmdlets.
4-
ms.date: 5/12/2018
5-
---
61
# PnP PowerShell overview
72

83
SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises.
@@ -104,6 +99,7 @@ Cmdlet|Description|Platform
10499
**[Get‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md)** |Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
105100
**[Uninstall‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md)** |Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
106101
**[Import‑PnPAppPackage](../../sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md)** |Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
102+
**[Grant‑PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md)** |Explicitely grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online
107103

108104

109105
### Base Cmdlets
@@ -358,6 +354,7 @@ Cmdlet|Description|Platform
358354
:-----|:----------|:-------
359355
**[Get‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md)** |Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
360356
**[Set‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md)** |Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
357+
**[Get‑PnPSearchCrawlLog](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md)** |Returns entries from the SharePoint search crawl log|SharePoint Online
361358
**[Submit‑PnPSearchQuery](../../sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md)** |Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
362359
**[Get‑PnPSiteSearchQueryResults](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md)** |Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
363360

@@ -434,7 +431,7 @@ Cmdlet|Description|Platform
434431
**[Unregister‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md)** |Unregisters a site as a hubsite|SharePoint Online
435432
**[Add‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md)** |Connects a site to a hubsite.|SharePoint Online
436433
**[Remove‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md)** |Disconnects a site from a hubsite.|SharePoint Online
437-
**[Grant‑PnPHubSiteRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md)** |Retrieve all or a specific hubsite.|SharePoint Online
434+
**[Grant‑PnPHubSiteRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md)** |Grant Permissions to associate sites to Hub Sites.|SharePoint Online
438435
**[Add‑PnPOffice365GroupToSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md)** |Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group|SharePoint Online
439436
**[Disable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md)** |Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
440437
**[Enable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md)** |Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Online

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Add/uploads an available app to the app catalog
1515
Add-PnPApp -Path <String>
1616
[-Scope <AppCatalogScope>]
1717
[-Overwrite [<SwitchParameter>]]
18+
[-Timeout <Int>]
1819
[-Connection <SPOnlineConnection>]
1920
```
2021

@@ -25,6 +26,7 @@ Add-PnPApp -Path <String>
2526
[-SkipFeatureDeployment [<SwitchParameter>]]
2627
[-Scope <AppCatalogScope>]
2728
[-Overwrite [<SwitchParameter>]]
29+
[-Timeout <Int>]
2830
[-Connection <SPOnlineConnection>]
2931
```
3032

@@ -113,6 +115,18 @@ Position: Named
113115
Accept pipeline input: False
114116
```
115117
118+
### -Timeout
119+
Specifies the timeout in seconds. Defaults to 200.
120+
121+
```yaml
122+
Type: Int
123+
Parameter Sets: (All)
124+
125+
Required: False
126+
Position: Named
127+
Accept pipeline input: False
128+
```
129+
116130
### -Connection
117131
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.
118132

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,13 @@ Add-PnPCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -
5757

5858
Adds a new custom action to the custom list template, and sets the Title, Name and other fields with the specified values. On click it shows the number of items in that list. Notice: escape quotes in CommandUIExtension.
5959

60+
### ------------------EXAMPLE 2------------------
61+
```powershell
62+
Add-PnPCustomAction -Title "CollabFooter" -Name "CollabFooter" -Location "ClientSideExtension.ApplicationCustomizer" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}
63+
```
64+
65+
Adds a new application customizer to the site. This requires that an SPFX solution has been deployed containing the application customizer specified.
66+
6067
## PARAMETERS
6168

6269
### -ClientSideComponentId

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You must be a SharePoint Online global administrator and a site collection admin
2525

2626
### ------------------EXAMPLE 1------------------
2727
```powershell
28-
Add-PnPTenantCdnOrigin -Url /sites/site/subfolder -CdnType Public
28+
Add-PnPTenantCdnOrigin -OriginUrl /sites/site/subfolder -CdnType Public
2929
```
3030

3131
This example configures a public CDN on site level.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Accept pipeline input: False
226226
```
227227
228228
### -Parameters
229-
Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.
229+
Allows you to specify parameters that can be referred to in the template by means of the {parameter:&lt;Key&gt;} token. See examples on how to use this parameter.
230230
231231
```yaml
232232
Type: Hashtable

‎sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@ Accept pipeline input: False
871871
```
872872
873873
### -TenantAdminUrl
874-
The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.
874+
The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://&lt;tenantname&gt;-admin.sharepoint.com where appropriate.
875875
876876
```yaml
877877
Type: String
@@ -907,7 +907,7 @@ Accept pipeline input: False
907907
```
908908
909909
### -UseWebLogin
910-
If you want to connect to SharePoint with browser based login
910+
If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled.
911911
912912
```yaml
913913
Type: SwitchParameter

‎sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Accept pipeline input: False
8484
```
8585
8686
### -IncludeID
87-
If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid>
87+
If specified will include the ids of the taxonomy items in the output. Format: &lt;label&gt;;#&lt;guid&gt;
8888
8989
```yaml
9090
Type: SwitchParameter

‎sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Returns all controls defined on the given page.
2828

2929
### ------------------EXAMPLE 2------------------
3030
```powershell
31-
Get-PnPClientSideComponent -Page Home -Identity a2875399-d6ff-43a0-96da-be6ae5875f82
31+
Get-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82
3232
```
3333

3434
Returns a specific control defined on the given page.

‎sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Get-PnPField [-Includes <String[]>]
1616
[-List <ListPipeBind>]
1717
[-Identity <FieldPipeBind>]
1818
[-Group <String>]
19+
[-InSiteHierarchy [<SwitchParameter>]]
1920
[-Web <WebPipeBind>]
2021
[-Connection <SPOnlineConnection>]
2122
```
@@ -74,6 +75,20 @@ Position: 0
7475
Accept pipeline input: False
7576
```
7677
78+
### -InSiteHierarchy
79+
Search site hierarchy for fields
80+
81+
Only applicable to: SharePoint Online
82+
83+
```yaml
84+
Type: SwitchParameter
85+
Parameter Sets: (All)
86+
87+
Required: False
88+
Position: Named
89+
Accept pipeline input: False
90+
```
91+
7792
### -List
7893
The list object or name where to get the field from
7994

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ Accept pipeline input: False
359359
```
360360
361361
### -ResourceFilePrefix
362-
If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info.
362+
If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.&lt;language&gt;.resx. See examples for more info.
363363
364364
Only applicable to: SharePoint Online, SharePoint Server 2016
365365

0 commit comments

Comments
 (0)