diff --git a/.deployment b/.deployment new file mode 100644 index 00000000..949add99 --- /dev/null +++ b/.deployment @@ -0,0 +1,2 @@ +[config] +project = assets/functions \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/function.json b/assets/functions/applyportaltemplate/function.json new file mode 100644 index 00000000..2f952522 --- /dev/null +++ b/assets/functions/applyportaltemplate/function.json @@ -0,0 +1,11 @@ +{ + "bindings": [ + { + "name": "triggerInput", + "type": "queueTrigger", + "direction": "in", + "queueName": "pnpspportalshowcasequeue" + } + ], + "disabled": false + } \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/AngleSharp.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/AngleSharp.dll new file mode 100644 index 00000000..89ceb200 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/AngleSharp.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Edm.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Edm.dll new file mode 100644 index 00000000..b975044e Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Edm.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.OData.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.OData.dll new file mode 100644 index 00000000..50b25678 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.OData.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Services.Client.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Services.Client.dll new file mode 100644 index 00000000..0f4c17b1 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Data.Services.Client.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.DependencyInjection.Abstractions.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.DependencyInjection.Abstractions.dll new file mode 100644 index 00000000..011f07d6 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.DependencyInjection.Abstractions.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Options.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Options.dll new file mode 100644 index 00000000..476d0e0d Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Options.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Primitives.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Primitives.dll new file mode 100644 index 00000000..4dbad7df Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.Primitives.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.WebEncoders.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.WebEncoders.dll new file mode 100644 index 00000000..5b0ea3a8 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Extensions.WebEncoders.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.Core.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.Core.dll new file mode 100644 index 00000000..196dff7e Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.Core.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.dll new file mode 100644 index 00000000..5fce4c33 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Graph.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.Platform.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.Platform.dll new file mode 100644 index 00000000..545befed Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.Platform.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.dll new file mode 100644 index 00000000..d7db417a Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Identity.Client.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll new file mode 100644 index 00000000..cb07f905 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.dll new file mode 100644 index 00000000..993b1068 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.Clients.ActiveDirectory.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.dll new file mode 100644 index 00000000..5c1c2056 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.IdentityModel.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.Policy.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.Policy.dll new file mode 100644 index 00000000..3259ba12 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.Policy.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.TranslationServices.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.TranslationServices.dll new file mode 100644 index 00000000..1263a782 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Office.Client.TranslationServices.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Online.SharePoint.Client.Tenant.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Online.SharePoint.Client.Tenant.dll new file mode 100644 index 00000000..84def399 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.Online.SharePoint.Client.Tenant.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.DocumentManagement.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.DocumentManagement.dll new file mode 100644 index 00000000..c7284362 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.DocumentManagement.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Publishing.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Publishing.dll new file mode 100644 index 00000000..bd6a3003 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Publishing.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Runtime.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Runtime.dll new file mode 100644 index 00000000..85c1130e Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Runtime.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.Applications.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.Applications.dll new file mode 100644 index 00000000..f0e5fe50 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.Applications.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.dll new file mode 100644 index 00000000..c7f41d60 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Search.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Taxonomy.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Taxonomy.dll new file mode 100644 index 00000000..cc2a66a9 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.Taxonomy.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.UserProfiles.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.UserProfiles.dll new file mode 100644 index 00000000..cdd9b09e Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.UserProfiles.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.WorkflowServices.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.WorkflowServices.dll new file mode 100644 index 00000000..28df404d Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.WorkflowServices.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.dll new file mode 100644 index 00000000..a6a6c64c Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.SharePoint.Client.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Configuration.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Configuration.dll new file mode 100644 index 00000000..c5e77973 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Configuration.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Storage.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Storage.dll new file mode 100644 index 00000000..51cba9a3 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Microsoft.WindowsAzure.Storage.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Newtonsoft.Json.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Newtonsoft.Json.dll new file mode 100644 index 00000000..77a5d89e Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/Newtonsoft.Json.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/OfficeDevPnP.Core.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/OfficeDevPnP.Core.dll new file mode 100644 index 00000000..24c2716a Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/OfficeDevPnP.Core.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.IdentityModel.Extensions.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.IdentityModel.Extensions.dll new file mode 100644 index 00000000..4621777a Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.IdentityModel.Extensions.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.CmdletHelpAttributes.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.CmdletHelpAttributes.dll new file mode 100644 index 00000000..8a2c3b30 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.CmdletHelpAttributes.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.Format.ps1xml b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.Format.ps1xml new file mode 100644 index 00000000..6c52dd36 --- /dev/null +++ b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.Format.ps1xml @@ -0,0 +1,1689 @@ + + + + Feature + + Microsoft.SharePoint.Client.Feature + + + + + 38 + left + + + left + + + + + + + DisplayName + + + DefinitionId + + + + + + + + AppInstance + + Microsoft.SharePoint.Client.AppInstance + + + + + 38 + left + + + left + + + + + + + Title + + + Id + + + + + + + + Web + + Microsoft.SharePoint.Client.Web + + + + + left + + + 38 + left + + + left + + + + + + + Title + + + ServerRelativeUrl + + + Id + + + + + + + + Site + + Microsoft.SharePoint.Client.Site + + + + + 55 + left + + + left + + + + + + + Url + + + CompatibilityLevel + + + + + + + + View + + Microsoft.SharePoint.Client.View + + + + + 30 + left + + + 38 + left + + + + 7 + left + + + + 8 + left + + + + + + + Title + + + Id + + + DefaultView + + + PersonalView + + + + + + + + List + + Microsoft.SharePoint.Client.List + + + + + left + + + 38 + left + + + + left + + + + + + + Title + + + Id + + + $_.RootFolder.ServerRelativeUrl + + + + + + + + ContentType + + Microsoft.SharePoint.Client.ContentType + + + + + 30 + left + + + 30 + left + + + 30 + left + + + 30 + left + + + + + + + Name + + + Id + + + Group + + + Description + + + + + + + + WebPartDefinition + + Microsoft.SharePoint.Client.WebParts.WebPartDefinition + + + + + + 30 + left + + + 36 + left + + + + + + + $_.WebPart.Title + + + Id + + + + + + + + Field + + Microsoft.SharePoint.Client.Field + + + + + left + + + left + + + 36 + left + + + + + + + Title + + + InternalName + + + Id + + + + + + + + Group + + Microsoft.SharePoint.Client.Group + + + + + 5 + left + + + 30 + left + + + 36 + left + + + + + + + Id + + + Title + + + LoginName + + + + + + + + PersonProperties + + Microsoft.SharePoint.Client.UserProfiles.PersonProperties + + + + + left + + + left + + + left + + + + + + + DisplayName + + + AccountName + + + PersonalUrl + + + + + + + + SiteProperties + + Microsoft.Online.SharePoint.TenantAdministration.SiteProperties + + + + + left + + + 20 + left + + + 5 + left + + + + + + + Url + + + Template + + + Lcid + + + + + + + + ListItem + + Microsoft.SharePoint.Client.ListItem + + + + + + 5 + left + + + + 50 + left + + + + left + + + + + + + Id + + + $_["Title"] + + + $_["GUID"] + + + + + + + + UserCustomAction + + Microsoft.SharePoint.Client.UserCustomAction + + + + + + left + + + + left + + + + 5 + left + + + + left + + + + + + + Name + + + Location + + + Scope + + + Id + + + + + + + + WebTemplate + + Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplate + + + + + + left + + + + 40 + left + + + + 15 + left + + + + 18 + left + + + + + + + Name + + + Title + + + DisplayCategory + + + CompatibilityLevel + + + + + + + + FolderItems + + Microsoft.SharePoint.Client.File + Microsoft.SharePoint.Client.Folder + + + + + + left + + + + left + + + + right + + + + left + + + + + + + + if($_.Name -eq ""){ + $_.ServerRelativeUrl.TrimEnd("/").Substring($_.ServerRelativeUrl.TrimEnd("/").LastIndexof("/") + 1) + } + else{ + $_.Name + } + + + + + if($_.GetType().Name -eq "Folder" -and $_.Name -eq ""){ + "Subweb" + } + else{ + $_.GetType().Name + } + + + + + if($_.GetType().Name -eq "File"){ + $_.Length + } + else{ + $_.ItemCount + } + + + + TimeLastModified + + + + + + + + File + + Microsoft.SharePoint.Client.File + + + + + + 30 + left + + + + 10 + left + + + + + + + Name + + + Length + + + + + + + + Folder + + Microsoft.SharePoint.Client.Folder + + + + + + 30 + left + + + + + + + Name + + + + + + + + ExtensibilityHandler + + OfficeDevPnP.Core.Framework.Provisioning.Model.ExtensibilityHandler + + + + + + 30 + left + + + + 30 + left + + + + 7 + left + + + + + + + Assembly + + + Type + + + Enabled + + + + + + + + TermGroup + + Microsoft.SharePoint.Client.Taxonomy.TermGroup + + + + + + 30 + left + + + + 36 + left + + + + + + + Name + + + Id + + + + + + + + TermSet + + Microsoft.SharePoint.Client.Taxonomy.TermSet + + + + + + 30 + left + + + + 36 + left + + + + + + + Name + + + Id + + + + + + + + Term + + Microsoft.SharePoint.Client.Taxonomy.Term + + + + + + 30 + left + + + + 36 + left + + + + + + + Name + + + Id + + + + + + + + ProvisioningTemplateInformation + + SharePointPnP.PowerShell.Commands.Components.ProvisioningTemplateInformation + + + + + + 30 + left + + + + 36 + left + + + + + + + DisplayName + + + Id + + + + + + + + UnifiedGroupEntity + + OfficeDevPnP.Core.Entities.UnifiedGroupEntity + + + + + + 30 + left + + + + 38 + left + + + + 38 + left + + + + + + + DisplayName + + + GroupId + + + SiteUrl + + + + + + + + RecycleBinItem + + Microsoft.SharePoint.Client.RecycleBinItem + + + + + + left + + + + 38 + left + + + + 10 + left + + + + left + + + + left + + + + + + + Title + + + Id + + + ItemType + + + LeafName + + + DirName + + + + + + + + ImageRendition + + Microsoft.SharePoint.Client.Publishing.ImageRendition + + + + + + Right + + + + left + + + + Right + + + + Right + + + + + + + Id + + + Name + + + Height + + + Width + + + + + + + + DeletedSiteProperties + + Microsoft.Online.SharePoint.TenantAdministration.DeletedSiteProperties + + + + + + right + + + + left + + + + left + + + + + + + DaysRemaining + + + DeletionTime + + + Url + + + + + + + + TermStore + + Microsoft.SharePoint.Client.Taxonomy.Termstore + + + + + + left + + + + left + + + + left + + + + left + + + + + + + Name + + + Id + + + + if($_.IsObjectPropertyInstantiated("Groups")){ + $_.Groups.Name + } + else{ + "Not loaded" + } + + + + + if($_.IsObjectPropertyInstantiated("KeywordsTermSet")){ + $_.KeywordsTermSet.Name + } + else{ + "Not loaded" + } + + + + + + + + + SitePolicyEntity + + OfficeDevPnP.Core.Entities.SitePolicyEntity + + + + + + left + + + + left + + + + + + + Name + + + Description + + + + + + + + EventReceiverDefinition + + Microsoft.SharePoint.Client.EventReceiverDefinition + + + + + + left + + + + left + + + + left + + + + left + + + + left + + + + + + + ReceiverName + + + ReceiverId + + + SequenceNumber + + + EventType + + + Synchronization + + + + + + + + RoleDefinition + + Microsoft.SharePoint.Client.RoleDefinition + + + + + + left + + + + left + + + + left + + + + right + + + + + + + Name + + + RoleTypeKind + + + Hidden + + + Order + + + + + + + + Audit + + Microsoft.SharePoint.Client.Audit + + + + + + left + + + + + + + AuditFlags + + + + + + + + User + + Microsoft.SharePoint.Client.User + + + + + + right + + + + left + + + + left + + + + left + + + + + + + Id + + + Title + + + LoginName + + + Email + + + + + + + + ClientSideComponent + + OfficeDevPnP.Core.Pages.ClientSideComponent + + + + + + left + + + + left + + + + left + + + + + + + Id + + + Name + + + (ConvertFrom-Json $_.Manifest).alias + + + + + + + + AppMetadata + + OfficeDevPnP.Core.ALM.AppMetadata + + + + + + left + + + + left + + + + left + + + + left + + + + left + + + + + + + Id + + + Title + + + Deployed + + + AppCatalogVersion + + + InstalledVersion + + + + + + + + TenantSiteDesign + + Microsoft.Online.SharePoint.TenantAdministration.TenantSiteDesign + + + + + + left + + + + left + + + + left + + + + + + + Id + + + Title + + + SiteScriptIds + + + + + + + + TenantSiteScript + + Microsoft.Online.SharePoint.TenantAdministration.TenantSiteScript + + + + + + left + + + + left + + + + left + + + + left + + + + + + + Id + + + Title + + + Version + + + Content + + + + + + + + TenantSiteDesignPrincipal + + Microsoft.Online.SharePoint.TenantAdministration.TenantSiteDesignPrincipal + + + + + + left + + + + left + + + + left + + + + + + + DisplayName + + + PrincipalName + + + Rights + + + + + + + + CanvasControl + + OfficeDevPnP.Core.Pages.CanvasControl + + + + + + left + + + + left + + + + left + + + + left + + + + left + + + + left + + + + left + + + + + + + InstanceId + + + $_.Type.Name + + + Title + + + $_.Section.Page.Sections.IndexOf($_.Section) + 1 + + + $_.Section.Columns.IndexOf($_.Column) + 1 + + + Order + + + PropertiesJson + + + + + + + + NavigationNode + + Microsoft.SharePoint.Client.NavigationNode + + + + + + left + + + + left + + + + left + + + + left + + + + + + + Id + + + Title + + + IsVisible + + + Url + + + + + + + + SPOTheme + + SharePointPnP.PowerShell.Commands.Model.SPOTheme + + + + + + left + + + + left + + + + + + + Name + + + Palette + + + + + + + + HubSiteProperties + + Microsoft.Online.SharePoint.TenantAdministration.HubSiteProperties + + + + + + left + + + + left + + + + left + + + + + + + SiteId + + + Title + + + SiteUrl + + + + + + + + TenantSiteScriptActionResult + + Microsoft.Online.SharePoint.TenantAdministration.TenantSiteScriptActionResult + + + + + + left + + + + left + + + + left + + + + + + + Title + + + OutcomeText + + + Outcome + + + + + + + + \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll new file mode 100644 index 00000000..c4667436 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll-help.xml b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll-help.xml new file mode 100644 index 00000000..1023531e --- /dev/null +++ b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnP.PowerShell.Online.Commands.dll-help.xml @@ -0,0 +1,59687 @@ + + + + + Add-PnPApp + + * Supported in: SharePoint Online. + +Add/uploads an available app to the app catalog + + + + + Add + PnPApp + + + + + Add-PnPApp + + Path + + Specifies the Id or an actual app metadata instance + + String + + + Overwrite + + Overwrites the existing app package if it already exists + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Add-PnPApp + + Publish + + This will deploy/trust an app into the app catalog + + SwitchParameter + + + Path + + Specifies the Id or an actual app metadata instance + + String + + + SkipFeatureDeployment + + + + SwitchParameter + + + Overwrite + + Overwrites the existing app package if it already exists + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Overwrite + + Overwrites the existing app package if it already exists + + SwitchParameter + + SwitchParameter + + + + + Path + + Specifies the Id or an actual app metadata instance + + String + + String + + + + + Publish + + This will deploy/trust an app into the app catalog + + SwitchParameter + + SwitchParameter + + + + + SkipFeatureDeployment + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + OfficeDevPnP.Core.ALM.AppMetadata + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPApp -Path ./myapp.sppkg + + This will upload the specified app package to the app catalog + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPApp -Path ./myapp.sppkg -Publish + + This will upload the specified app package to the app catalog and deploy/trust it at the same time. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPClientSidePage + + * Supported in: SharePoint Online. + +Adds a Client-Side Page + + + + + Add + PnPClientSidePage + + + + + Add-PnPClientSidePage + + Name + + Specifies the name of the page. + + String + + + LayoutType + + Specifies the layout type of the page. + + ClientSidePageLayoutType + + + PromoteAs + + Allows to promote the page for a specific purpose (HomePage | NewsPage) + + ClientSidePagePromoteType + + + CommentsEnabled + + Enables or Disables the comments on the page + + SwitchParameter + + + Publish + + Publishes the page once it is saved. Applicable to libraries set to create major and minor versions. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + CommentsEnabled + + Enables or Disables the comments on the page + + SwitchParameter + + SwitchParameter + + + + + LayoutType + + Specifies the layout type of the page. + + ClientSidePageLayoutType + + ClientSidePageLayoutType + + + + + Name + + Specifies the name of the page. + + String + + String + + + + + PromoteAs + + Allows to promote the page for a specific purpose (HomePage | NewsPage) + + ClientSidePagePromoteType + + ClientSidePagePromoteType + + + + + Publish + + Publishes the page once it is saved. Applicable to libraries set to create major and minor versions. + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPClientSidePage -Name "NewPage" + + Creates a new Client-Side page named 'NewPage' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPClientSidePage "NewPage" + + Creates a new Client-Side page named 'NewPage' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPClientSidePageSection + + * Supported in: SharePoint Online. + +Adds a new section to a Client-Side page + + + + + Add + PnPClientSidePageSection + + + + + Add-PnPClientSidePageSection + + SectionTemplate + + Specifies the columns template to use for the section. + + CanvasSectionTemplate + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Order + + Sets the order of the section. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Order + + Sets the order of the section. (Default = 1) + + Int32 + + Int32 + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + SectionTemplate + + Specifies the columns template to use for the section. + + CanvasSectionTemplate + + CanvasSectionTemplate + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate OneColumn + + Adds a new one-column section to the Client-Side page 'MyPage' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate ThreeColumn -Order 10 + + Adds a new Three columns section to the Client-Side page 'MyPage' with an order index of 10 + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> $page = Add-PnPClientSidePage -Name "MyPage" +PS> Add-PnPClientSidePageSection -Page $page -SectionTemplate OneColumn + + Adds a new one column section to the Client-Side page 'MyPage' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPClientSideText + + * Supported in: SharePoint Online. + +Adds a text element to a client-side page. + + + + + Add + PnPClientSideText + + + + Adds a new text element to a section on a client-side page. + + + + Add-PnPClientSideText + + Text + + Specifies the text to display in the text area. + + String + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + Order + + Sets the order of the text control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPClientSideText + + Text + + Specifies the text to display in the text area. + + String + + + Section + + Sets the section where to insert the text control. + + Int32 + + + Column + + Sets the column where to insert the text control. + + Int32 + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + Order + + Sets the order of the text control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Column + + Sets the column where to insert the text control. + + Int32 + + Int32 + + + + + Order + + Sets the order of the text control. (Default = 1) + + Int32 + + Int32 + + + + + Page + + The name of the page. + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + Section + + Sets the section where to insert the text control. + + Int32 + + Int32 + + + + + Text + + Specifies the text to display in the text area. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPClientSideText -Page "MyPage" -Text "Hello World!" + + Adds the text 'Hello World!' to the Client-Side Page 'MyPage' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPClientSideWebPart + + * Supported in: SharePoint Online. + +Adds a Client-Side Web Part to a client-side page + + + + + Add + PnPClientSideWebPart + + + + Adds a client-side web part to an existing client-side page. + + + + Add-PnPClientSideWebPart + + DefaultWebPartType + + Defines a default WebPart type to insert. + + DefaultClientSideWebParts + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + WebPartProperties + + The properties of the WebPart + + PropertyBagPipeBind + + + Order + + Sets the order of the WebPart control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPClientSideWebPart + + Component + + Specifies the component instance or Id to add. + + ClientSideComponentPipeBind + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + WebPartProperties + + The properties of the WebPart + + PropertyBagPipeBind + + + Order + + Sets the order of the WebPart control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPClientSideWebPart + + DefaultWebPartType + + Defines a default WebPart type to insert. + + DefaultClientSideWebParts + + + Section + + Sets the section where to insert the WebPart control. + + Int32 + + + Column + + Sets the column where to insert the WebPart control. + + Int32 + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + WebPartProperties + + The properties of the WebPart + + PropertyBagPipeBind + + + Order + + Sets the order of the WebPart control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPClientSideWebPart + + Component + + Specifies the component instance or Id to add. + + ClientSideComponentPipeBind + + + Section + + Sets the section where to insert the WebPart control. + + Int32 + + + Column + + Sets the column where to insert the WebPart control. + + Int32 + + + Page + + The name of the page. + + ClientSidePagePipeBind + + + WebPartProperties + + The properties of the WebPart + + PropertyBagPipeBind + + + Order + + Sets the order of the WebPart control. (Default = 1) + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Column + + Sets the column where to insert the WebPart control. + + Int32 + + Int32 + + + + + Component + + Specifies the component instance or Id to add. + + ClientSideComponentPipeBind + + ClientSideComponentPipeBind + + + + + DefaultWebPartType + + Defines a default WebPart type to insert. + + DefaultClientSideWebParts + + DefaultClientSideWebParts + + + + + Order + + Sets the order of the WebPart control. (Default = 1) + + Int32 + + Int32 + + + + + Page + + The name of the page. + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + Section + + Sets the section where to insert the WebPart control. + + Int32 + + Int32 + + + + + WebPartProperties + + The properties of the WebPart + + PropertyBagPipeBind + + PropertyBagPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPClientSideWebPart -Page "MyPage" -DefaultWebPartType BingMap + + Adds a built-in Client-Side component 'BingMap' to the page called 'MyPage' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld" + + Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld" -Section 1 -Column 2 + + Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' in section 1 and column 2 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPContentType + + Adds a new content type + + + + + Add + PnPContentType + + + + + Add-PnPContentType + + Name + + Specify the name of the new content type + + String + + + ContentTypeId + + If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID + + String + + + Description + + Specifies the description of the new content type + + String + + + Group + + Specifies the group of the new content type + + String + + + ParentContentType + + Specifies the parent of the new content type + + ContentType + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentTypeId + + If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID + + String + + String + + + + + Description + + Specifies the description of the new content type + + String + + String + + + + + Group + + Specifies the group of the new content type + + String + + String + + + + + Name + + Specify the name of the new content type + + String + + String + + + + + ParentContentType + + Specifies the parent of the new content type + + ContentType + + ContentType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.ContentType + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct + + This will add a new content type based on the parent content type stored in the $ct variable. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPContentTypeToDocumentSet + + Adds a content type to a document set + + + + + Add + PnPContentTypeToDocumentSet + + + + + Add-PnPContentTypeToDocumentSet + + ContentType + + The content type object, name or id to add. Either specify name, an id, or a content type object. + + ContentTypePipeBind[] + + + DocumentSet + + The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The content type object, name or id to add. Either specify name, an id, or a content type object. + + ContentTypePipeBind[] + + ContentTypePipeBind[] + + + + + DocumentSet + + The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + DocumentSetPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" + + This will add the content type called 'Test CT' to the document set called ''Test Document Set' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set" +PS:> $ct = Get-PnPContentType -Identity "Test CT" +PS:> Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset + + This will add the content type called 'Test CT' to the document set called ''Test Document Set' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B + + This will add the content type called 'Test CT' to the document set called ''Test Document Set' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPContentTypeToList + + Adds a new content type to a list + + + + + Add + PnPContentTypeToList + + + + + Add-PnPContentTypeToList + + List + + Specifies the list to which the content type needs to be added + + ListPipeBind + + + ContentType + + Specifies the content type that needs to be added to the list + + ContentTypePipeBind + + + DefaultContentType + + Specify if the content type needs to be the default content type or not + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + Specifies the content type that needs to be added to the list + + ContentTypePipeBind + + ContentTypePipeBind + + + + + DefaultContentType + + Specify if the content type needs to be the default content type or not + + SwitchParameter + + SwitchParameter + + + + + List + + Specifies the list to which the content type needs to be added + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType + + This will add an existing content type to a list and sets it as the default content type + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPCustomAction + + Adds a custom action + + + + + Add + PnPCustomAction + + + + Adds a user custom action to a web or sitecollection. + + + + Add-PnPCustomAction + + Name + + The name of the custom action + + String + + + Title + + The title of the custom action + + String + + + Location + + The actual location where this custom action need to be added like 'CommandUI.Ribbon' + + String + + + ClientSideComponentId + + The Client Side Component Id of the custom action + + GuidPipeBind + + + RegistrationId + + The identifier of the object associated with the custom action. + + String + + + RegistrationType + + Specifies the type of object associated with the custom action + + UserCustomActionRegistrationType + + + Scope + + The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. + + CustomActionScope + + + ClientSideComponentProperties + + The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}" + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPCustomAction + + Name + + The name of the custom action + + String + + + Title + + The title of the custom action + + String + + + Description + + The description of the custom action + + String + + + Group + + The group where this custom action needs to be added like 'SiteActions' + + String + + + Location + + The actual location where this custom action need to be added like 'CommandUI.Ribbon' + + String + + + Sequence + + Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page. + + Int32 + + + Url + + The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action + + String + + + ImageUrl + + The URL of the image associated with the custom action + + String + + + CommandUIExtension + + XML fragment that determines user interface properties of the custom action + + String + + + RegistrationId + + The identifier of the object associated with the custom action. + + String + + + Rights + + A string array that contain the permissions needed for the custom action + + PermissionKind[] + + + RegistrationType + + Specifies the type of object associated with the custom action + + UserCustomActionRegistrationType + + + Scope + + The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. + + CustomActionScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ClientSideComponentId + + The Client Side Component Id of the custom action + + GuidPipeBind + + GuidPipeBind + + + + + ClientSideComponentProperties + + The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}" + + String + + String + + + + + CommandUIExtension + + XML fragment that determines user interface properties of the custom action + + String + + String + + + + + Description + + The description of the custom action + + String + + String + + + + + Group + + The group where this custom action needs to be added like 'SiteActions' + + String + + String + + + + + ImageUrl + + The URL of the image associated with the custom action + + String + + String + + + + + Location + + The actual location where this custom action need to be added like 'CommandUI.Ribbon' + + String + + String + + + + + Name + + The name of the custom action + + String + + String + + + + + RegistrationId + + The identifier of the object associated with the custom action. + + String + + String + + + + + RegistrationType + + Specifies the type of object associated with the custom action + + UserCustomActionRegistrationType + + UserCustomActionRegistrationType + + + + + Rights + + A string array that contain the permissions needed for the custom action + + PermissionKind[] + + PermissionKind[] + + + + + Scope + + The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. + + CustomActionScope + + CustomActionScope + + + + + Sequence + + Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page. + + Int32 + + Int32 + + + + + Title + + The title of the custom action + + String + + String + + + + + Url + + The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + $cUIExtn = "<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location=""Ribbon.List.Share.Controls._children""><Button Id=""Ribbon.List.Share.GetItemsCountButton"" Alt=""Get list items count"" Sequence=""11"" Command=""Invoke_GetItemsCountButtonRequest"" LabelText=""Get Items Count"" TemplateAlias=""o1"" Image32by32=""_layouts/15/images/placeholder32x32.png"" Image16by16=""_layouts/15/images/placeholder16x16.png"" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command=""Invoke_GetItemsCountButtonRequest"" CommandAction=""javascript: alert('Total items in this list: '+ ctx.TotalListItems);"" EnabledScript=""javascript: function checkEnable() { return (true);} checkEnable();""/></CommandUIHandlers></CommandUIExtension>" + +Add-PnPCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -Description 'Adds custom action to custom list ribbon' -Group 'SiteActions' -Location 'CommandUI.Ribbon' -CommandUIExtension $cUIExtn + + 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. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + UserCustomAction: + https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.usercustomaction.aspx + + + BasePermissions: + https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.basepermissions.aspx + + + + + + Add-PnPDataRowsToProvisioningTemplate + + Adds datarows to a list inside a PnP Provisioning Template + + + + + Add + PnPDataRowsToProvisioningTemplate + + + + + Add-PnPDataRowsToProvisioningTemplate + + List + + The list to query + + ListPipeBind + + + Query + + The CAML query to execute against the list + + String + + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + + TokenizeUrls + + If set, this switch will try to tokenize the values with web and site related tokens + + SwitchParameter + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + + IncludeSecurity + + A switch to include ObjectSecurity information. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + String[] + + + + + IncludeSecurity + + A switch to include ObjectSecurity information. + + SwitchParameter + + SwitchParameter + + + + + List + + The list to query + + ListPipeBind + + ListPipeBind + + + + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + String + + + + + Query + + The CAML query to execute against the list + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + TokenizeUrls + + If set, this switch will try to tokenize the values with web and site related tokens + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' + + Adds datarows to a list in an in-memory PnP Provisioning Template + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' -IncludeSecurity + + Adds datarows to a list in an in-memory PnP Provisioning Template + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPDocumentSet + + Creates a new document set in a library. + + + + + Add + PnPDocumentSet + + + + + Add-PnPDocumentSet + + List + + The name of the list, its ID or an actual list object from where the document set needs to be added + + ListPipeBind + + + Name + + The name of the document set + + String + + + ContentType + + The name of the content type, its ID or an actual content object referencing to the document set. + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The name of the content type, its ID or an actual content object referencing to the document set. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + List + + The name of the list, its ID or an actual list object from where the document set needs to be added + + ListPipeBind + + ListPipeBind + + + + + Name + + The name of the document set + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test" + + This will add a new document set based upon the 'Test Document Set' content type to a list called 'Documents'. The document set will be named 'Test' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPEventReceiver + + Adds a new remote event receiver + + + + + Add + PnPEventReceiver + + + + + Add-PnPEventReceiver + + Name + + The name of the remote event receiver + + String + + + Url + + The URL of the remote event receiver web service + + String + + + EventReceiverType + + The type of the event receiver like ItemAdded, ItemAdding. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx for the full list of available types. + + EventReceiverType + + + Synchronization + + The synchronization type: Asynchronous or Synchronous + + EventReceiverSynchronization + + + List + + The list object or name where the remote event receiver needs to be added. If omitted, the remote event receiver will be added to the web. + + ListPipeBind + + + SequenceNumber + + The sequence number where this remote event receiver should be placed + + Int32 + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + EventReceiverType + + The type of the event receiver like ItemAdded, ItemAdding. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx for the full list of available types. + + EventReceiverType + + EventReceiverType + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + List + + The list object or name where the remote event receiver needs to be added. If omitted, the remote event receiver will be added to the web. + + ListPipeBind + + ListPipeBind + + + + + Name + + The name of the remote event receiver + + String + + String + + + + + SequenceNumber + + The sequence number where this remote event receiver should be placed + + Int32 + + Int32 + + + + + Synchronization + + The synchronization type: Asynchronous or Synchronous + + EventReceiverSynchronization + + EventReceiverSynchronization + + + + + Url + + The URL of the remote event receiver web service + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.EventReceiverDefinition + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous + + This will add a new remote event receiver that is executed after an item has been added to the ProjectList list + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType WebAdding -Synchronization Synchronous + + This will add a new remote event receiver that is executed while a new subsite is being created + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPField + + Add a field + + + + + Add + PnPField + + + + Adds a field to a list or as a site column + + + + Add-PnPField + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + + Group + + The group name to where this field belongs to + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPField + + List + + The name of the list, its ID or an actual list object where this field needs to be added + + ListPipeBind + + + Field + + The name of the field, its ID or an actual field object that needs to be added + + FieldPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPField + + DisplayName + + The display name of the field + + String + + + InternalName + + The internal name of the field + + String + + + Type + + The type of the field like Choice, Note, MultiChoice + + FieldType + + + List + + The name of the list, its ID or an actual list object where this field needs to be added + + ListPipeBind + + + Id + + The ID of the field, must be unique + + GuidPipeBind + + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + + Group + + The group name to where this field belongs to + + String + + + ClientSideComponentId + + The Client Side Component Id to set to the field + + GuidPipeBind + + + ClientSideComponentProperties + + The Client Side Component Properties to set to the field + + String + + + Choices + + Specify choices, only valid if the field type is Choice + + String[] + + + Formula + + Specify the formula. Only available if the field type is Calculated + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPField + + DisplayName + + The display name of the field + + String + + + InternalName + + The internal name of the field + + String + + + Type + + The type of the field like Choice, Note, MultiChoice + + FieldType + + + Id + + The ID of the field, must be unique + + GuidPipeBind + + + ClientSideComponentId + + The Client Side Component Id to set to the field + + GuidPipeBind + + + ClientSideComponentProperties + + The Client Side Component Properties to set to the field + + String + + + Choices + + Specify choices, only valid if the field type is Choice + + String[] + + + Formula + + Specify the formula. Only avialable if the field type is Calculated + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + SwitchParameter + + + + + Choices + + Specify choices, only valid if the field type is Choice + + String[] + + String[] + + + + + ClientSideComponentId + + The Client Side Component Id to set to the field + + GuidPipeBind + + GuidPipeBind + + + + + ClientSideComponentProperties + + The Client Side Component Properties to set to the field + + String + + String + + + + + DisplayName + + The display name of the field + + String + + String + + + + + Field + + The name of the field, its ID or an actual field object that needs to be added + + FieldPipeBind + + FieldPipeBind + + + + + Formula + + Specify the formula. Only available if the field type is Calculated + + String + + String + + + + + Group + + The group name to where this field belongs to + + String + + String + + + + + Id + + The ID of the field, must be unique + + GuidPipeBind + + GuidPipeBind + + + + + InternalName + + The internal name of the field + + String + + String + + + + + List + + The name of the list, its ID or an actual list object where this field needs to be added + + ListPipeBind + + ListPipeBind + + + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + SwitchParameter + + + + + Type + + The type of the field like Choice, Note, MultiChoice + + FieldType + + FieldType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPField -Type Calculated -InternalName "C1" -DisplayName "C1" -Formula ="[Title]" + + Adds a new calculated site column with the formula specified + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPField -List "Demo list" -DisplayName "Location" -InternalName "SPSLocation" -Type Choice -Group "Demo Group" -AddToDefaultView -Choices "Stockholm","Helsinki","Oslo" + + This will add a field of type Choice to the list "Demo List". + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:>Add-PnPField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeakers" -Type MultiChoice -Group "Demo Group" -AddToDefaultView -Choices "Obiwan Kenobi","Darth Vader", "Anakin Skywalker" + + This will add a field of type Multiple Choice to the list "Demo List". (you can pick several choices for the same item) + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPFieldFromXml + + Adds a field to a list or as a site column based upon a CAML/XML field definition + + + + + Add + PnPFieldFromXml + + + + + Add-PnPFieldFromXml + + FieldXml + + CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx + + String + + + List + + The name of the list, its ID or an actual list object where this field needs to be added + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + FieldXml + + CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx + + String + + String + + + + + List + + The name of the list, its ID or an actual list object where this field needs to be added + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' +PS:> Add-PnPFieldFromXml -FieldXml $xml + + Adds a field with the specified field CAML code to the site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' +PS:> Add-PnPFieldFromXml -List "Demo List" -FieldXml $xml + + Adds a field with the specified field CAML code to the list "Demo List". + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Field CAML: + http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx + + + + + + Add-PnPFieldToContentType + + Adds an existing site column to a content type + + + + + Add + PnPFieldToContentType + + + + + Add-PnPFieldToContentType + + Field + + Specifies the field that needs to be added to the content type + + FieldPipeBind + + + ContentType + + Specifies which content type a field needs to be added to + + ContentTypePipeBind + + + Required + + Specifies whether the field is required or not + + SwitchParameter + + + Hidden + + Specifies whether the field should be hidden or not + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + Specifies which content type a field needs to be added to + + ContentTypePipeBind + + ContentTypePipeBind + + + + + Field + + Specifies the field that needs to be added to the content type + + FieldPipeBind + + FieldPipeBind + + + + + Hidden + + Specifies whether the field should be hidden or not + + SwitchParameter + + SwitchParameter + + + + + Required + + Specifies whether the field is required or not + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPFieldToContentType -Field "Project_Name" -ContentType "Project Document" + + This will add an existing site column with an internal name of "Project_Name" to a content type called "Project Document" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPFile + + Uploads a file to Web + + + + + Add + PnPFile + + + + + Add-PnPFile + + Path + + The local file path. + + String + + + Folder + + The destination folder in the site + + String + + + Checkout + + If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again. + + SwitchParameter + + + CheckInComment + + The comment added to the checkin. + + String + + + Approve + + Will auto approve the uploaded file. + + SwitchParameter + + + ApproveComment + + The comment added to the approval. + + String + + + Publish + + Will auto publish the file. + + SwitchParameter + + + PublishComment + + The comment added to the publish action. + + String + + + UseWebDav + + + + SwitchParameter + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"Title" = "Title New"} + +Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} + +Choice: -Values @{"Choice" = "Value 1"} + +Number: -Values @{"Number" = "10"} + +Currency: -Values @{"Number" = "10"} + +Currency: -Values @{"Currency" = "10"} + +Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"Lookup" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNo" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} + +Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + + ContentType + + Use to assign a ContentType to the file. + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPFile + + FileName + + Name for file + + String + + + Stream + + Stream with the file contents + + Stream + + + Folder + + The destination folder in the site + + String + + + Checkout + + If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again. + + SwitchParameter + + + CheckInComment + + The comment added to the checkin. + + String + + + Approve + + Will auto approve the uploaded file. + + SwitchParameter + + + ApproveComment + + The comment added to the approval. + + String + + + Publish + + Will auto publish the file. + + SwitchParameter + + + PublishComment + + The comment added to the publish action. + + String + + + UseWebDav + + + + SwitchParameter + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"Title" = "Title New"} + +Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} + +Choice: -Values @{"Choice" = "Value 1"} + +Number: -Values @{"Number" = "10"} + +Currency: -Values @{"Number" = "10"} + +Currency: -Values @{"Currency" = "10"} + +Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"Lookup" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNo" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} + +Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + + ContentType + + Use to assign a ContentType to the file. + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Approve + + Will auto approve the uploaded file. + + SwitchParameter + + SwitchParameter + + + + + ApproveComment + + The comment added to the approval. + + String + + String + + + + + CheckInComment + + The comment added to the checkin. + + String + + String + + + + + Checkout + + If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again. + + SwitchParameter + + SwitchParameter + + + + + ContentType + + Use to assign a ContentType to the file. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + FileName + + Name for file + + String + + String + + + + + Folder + + The destination folder in the site + + String + + String + + + + + Path + + The local file path. + + String + + String + + + + + Publish + + Will auto publish the file. + + SwitchParameter + + SwitchParameter + + + + + PublishComment + + The comment added to the publish action. + + String + + String + + + + + Stream + + Stream with the file contents + + Stream + + Stream + + + + + UseWebDav + + + + SwitchParameter + + SwitchParameter + + + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"Title" = "Title New"} + +Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} + +Choice: -Values @{"Choice" = "Value 1"} + +Number: -Values @{"Number" = "10"} + +Currency: -Values @{"Number" = "10"} + +Currency: -Values @{"Currency" = "10"} + +Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"Lookup" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNo" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} + +Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.File + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPFile -Path c:\temp\company.master -Folder "_catalogs/masterpage" + + This will upload the file company.master to the masterpage catalog + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPFile -Path .\displaytemplate.html -Folder "_catalogs/masterpage/display templates/test" + + This will upload the file displaytemplate.html to the test folder in the display templates folder. If the test folder does not exist it will create it. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPFile -Path .\sample.doc -Folder "Shared Documents" -Values @{Modified="1/1/2016"} + + This will upload the file sample.doc to the Shared Documnets folder. After uploading it will set the Modified date to 1/1/2016. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -Stream $fileStream -Values @{Modified="1/1/2016"} + + This will add a file sample.doc with the contents of the stream into the Shared Documents folder. After adding it will set the Modified date to 1/1/2016. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="1/1/2016"} + + This will add a file sample.doc to the Shared Documents folder, with a ContentType of 'Documents'. After adding it will set the Modified date to 1/1/2016. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Add-PnPFile -FileName sample.docx -Folder "Documents" -Values @{Modified="1/1/2016"; Created="1/1/2017"; Editor=23} + + 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. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPFileToProvisioningTemplate + + Adds a file to a PnP Provisioning Template + + + + + Add + PnPFileToProvisioningTemplate + + + + + Add-PnPFileToProvisioningTemplate + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + + Source + + The file to add to the in-memory template, optionally including full path. + + String + + + Folder + + The target Folder for the file to add to the in-memory template. + + String + + + Container + + The target Container for the file to add to the in-memory template, optional argument. + + String + + + FileLevel + + The level of the files to add. Defaults to Published + + FileLevel + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + + FileOverwrite + + Set to overwrite in site, Defaults to true + + SwitchParameter + + + + + + Container + + The target Container for the file to add to the in-memory template, optional argument. + + String + + String + + + + + FileLevel + + The level of the files to add. Defaults to Published + + FileLevel + + FileLevel + + + + + FileOverwrite + + Set to overwrite in site, Defaults to true + + SwitchParameter + + SwitchParameter + + + + + Folder + + The target Folder for the file to add to the in-memory template. + + String + + String + + + + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + String + + + + + Source + + The file to add to the in-memory template, optionally including full path. + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder + + Adds a file to a PnP Provisioning Template + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPFileToProvisioningTemplate -Path template.xml -Source $sourceFilePath -Folder $targetFolder + + Adds a file reference to a PnP Provisioning XML Template + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source "./myfile.png" -Folder "folderinsite" -FileLevel Published -FileOverwrite:$false + + Adds a file to a PnP Provisioning Template, specifies the level as Published and defines to not overwrite the file if it exists in the site. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -Container $container + + Adds a file to a PnP Provisioning Template with a custom container for the file + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPFolder + + Creates a folder within a parent folder + + + + + Add + PnPFolder + + + + + Add-PnPFolder + + Name + + The folder name + + String + + + Folder + + The parent folder in the site + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + The parent folder in the site + + String + + String + + + + + Name + + The folder name + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPFolder -Name NewFolder -Folder _catalogs/masterpage + + This will create the folder NewFolder in the masterpage catalog + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPHtmlPublishingPageLayout + + Adds a HTML based publishing page layout + + + + + Add + PnPHtmlPublishingPageLayout + + + + + Add-PnPHtmlPublishingPageLayout + + SourceFilePath + + Path to the file which will be uploaded + + String + + + Title + + Title for the page layout + + String + + + Description + + Description for the page layout + + String + + + AssociatedContentTypeID + + Associated content type ID + + String + + + DestinationFolderHierarchy + + Folder hierarchy where the HTML page layouts will be deployed + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AssociatedContentTypeID + + Associated content type ID + + String + + String + + + + + Description + + Description for the page layout + + String + + String + + + + + DestinationFolderHierarchy + + Folder hierarchy where the HTML page layouts will be deployed + + String + + String + + + + + SourceFilePath + + Path to the file which will be uploaded + + String + + String + + + + + Title + + Title for the page layout + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPHtmlPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 + + Uploads the pagelayout 'customlayout.aspx' from the current location to the current site as a 'web part page' pagelayout + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPHubSiteAssociation + + * Supported in: SharePoint Online. + +Connects a site to a hubsite. + + + + + Add + PnPHubSiteAssociation + + + + Connects an existing site to a hubsite + + + + Add-PnPHubSiteAssociation + + Site + + The site to connect to the hubsite + + SitePipeBind + + + HubSite + + The hubsite to connect the site to + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + HubSite + + The hubsite to connect the site to + + SitePipeBind + + SitePipeBind + + + + + Site + + The site to connect to the hubsite + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite + + This example adds the specified site to the hubsite. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPIndexedProperty + + Marks the value of the propertybag key specified to be indexed by search. + + + + + Add + PnPIndexedProperty + + + + + Add-PnPIndexedProperty + + Key + + Key of the property bag value to be indexed + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Key + + Key of the property bag value to be indexed + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPJavaScriptBlock + + Adds a link to a JavaScript snippet/block to a web or site collection + + + + + Add + PnPJavaScriptBlock + + + + Specify a scope as 'Site' to add the custom action to all sites in a site collection. + + + + Add-PnPJavaScriptBlock + + Name + + The name of the script block. Can be used to identify the script with other cmdlets or coded solutions + + String + + + Script + + The javascript block to add to the specified scope + + String + + + Sequence + + A sequence number that defines the order on the page + + Int32 + + + Scope + + The scope of the script to add to. Either Web or Site, defaults to Web. 'All' is not valid for this command. + + CustomActionScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Name + + The name of the script block. Can be used to identify the script with other cmdlets or coded solutions + + String + + String + + + + + Scope + + The scope of the script to add to. Either Web or Site, defaults to Web. 'All' is not valid for this command. + + CustomActionScope + + CustomActionScope + + + + + Script + + The javascript block to add to the specified scope + + String + + String + + + + + Sequence + + A sequence number that defines the order on the page + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' -Sequence 9999 -Scope Site + + Add a JavaScript code block to all pages within the current site collection under the name myAction and at order 9999 + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' + + Add a JavaScript code block to all pages within the current web under the name myAction + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPJavaScriptLink + + Adds a link to a JavaScript file to a web or sitecollection + + + + + Add + PnPJavaScriptLink + + + + Creates a custom action that refers to a JavaScript file + + + + Add-PnPJavaScriptLink + + Name + + Name under which to register the JavaScriptLink + + String + + + Url + + URL to the JavaScript file to inject + + String[] + + + Sequence + + Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI. + + Int32 + + + Scope + + Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web. + + CustomActionScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Name + + Name under which to register the JavaScriptLink + + String + + String + + + + + Scope + + Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web. + + CustomActionScope + + CustomActionScope + + + + + Sequence + + Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI. + + Int32 + + Int32 + + + + + Url + + URL to the JavaScript file to inject + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -Sequence 9999 -Scope Site + + Injects a reference to the latest v1 series jQuery library to all pages within the current site collection under the name jQuery and at order 9999 + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js + + Injects a reference to the latest v1 series jQuery library to all pages within the current web under the name jQuery + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPListFoldersToProvisioningTemplate + + Adds folders to a list in a PnP Provisioning Template + + + + + Add + PnPListFoldersToProvisioningTemplate + + + + + Add-PnPListFoldersToProvisioningTemplate + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + + List + + The list to query + + ListPipeBind + + + Recursive + + A switch parameter to include all folders in the list, or just top level folders. + + SwitchParameter + + + IncludeSecurity + + A switch to include ObjectSecurity information. + + SwitchParameter + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + IncludeSecurity + + A switch to include ObjectSecurity information. + + SwitchParameter + + SwitchParameter + + + + + List + + The list to query + + ListPipeBind + + ListPipeBind + + + + + Path + + Filename of the .PNP Open XML provisioning template to read from, optionally including full path. + + String + + String + + + + + Recursive + + A switch parameter to include all folders in the list, or just top level folders. + + SwitchParameter + + SwitchParameter + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' + + Adds top level folders from a list to an existing template and returns an in-memory PnP Provisioning Template + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive + + Adds all folders from a list to an existing template and returns an in-memory PnP Provisioning Template + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive -IncludeSecurity + + Adds all folders from a list with unique permissions to an in-memory PnP Provisioning Template + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPListItem + + Adds an item to a list + + + + + Add + PnPListItem + + + + + Add-PnPListItem + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + ContentType + + Specify either the name, ID or an actual content type. + + ContentTypePipeBind + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"Title" = "Title New"} + +Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} + +Choice: -Values @{"Choice" = "Value 1"} + +Number: -Values @{"Number" = "10"} + +Currency: -Values @{"Number" = "10"} + +Currency: -Values @{"Currency" = "10"} + +Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"Lookup" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNo" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} + +Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + + Folder + + The list relative URL of a folder. E.g. "MyFolder" for a folder located in the root of the list, or "MyFolder/SubFolder" for a folder located in the MyFolder folder which is located in the root of the list. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + Specify either the name, ID or an actual content type. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + Folder + + The list relative URL of a folder. E.g. "MyFolder" for a folder located in the root of the list, or "MyFolder/SubFolder" for a folder located in the MyFolder folder which is located in the root of the list. + + String + + String + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"Title" = "Title New"} + +Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} + +Choice: -Values @{"Choice" = "Value 1"} + +Number: -Values @{"Number" = "10"} + +Currency: -Values @{"Number" = "10"} + +Currency: -Values @{"Currency" = "10"} + +Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"Lookup" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNo" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} + +Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.ListItem + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Add-PnPListItem -List "Demo List" -Values @{"Title" = "Test Title"; "Category"="Test Category"} + + Adds a new list item to the "Demo List", and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Add-PnPListItem -List "Demo List" -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"} + + Adds a new list item to the "Demo List", sets the content type to "Company" and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + Add-PnPListItem -List "Demo List" -Values @{"MultiUserField"="user1@domain.com","user2@domain.com"} + + Adds a new list item to the "Demo List" and sets the user field called MultiUserField to 2 users. Separate multiple users with a comma. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Folder "projects/europe" + + Adds a new list item to the "Demo List". It will add the list item to the europe folder which is located in the projects folder. Folders will be created if needed. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPMasterPage + + Adds a Masterpage + + + + + Add + PnPMasterPage + + + + + Add-PnPMasterPage + + SourceFilePath + + Path to the file which will be uploaded + + String + + + Title + + Title for the Masterpage + + String + + + Description + + Description for the Masterpage + + String + + + DestinationFolderHierarchy + + Folder hierarchy where the MasterPage will be deployed + + String + + + UIVersion + + UIVersion of the Masterpage. Default = 15 + + String + + + DefaultCssFile + + Default CSS file for the MasterPage, this Url is SiteRelative + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + DefaultCssFile + + Default CSS file for the MasterPage, this Url is SiteRelative + + String + + String + + + + + Description + + Description for the Masterpage + + String + + String + + + + + DestinationFolderHierarchy + + Folder hierarchy where the MasterPage will be deployed + + String + + String + + + + + SourceFilePath + + Path to the file which will be uploaded + + String + + String + + + + + Title + + Title for the Masterpage + + String + + String + + + + + UIVersion + + UIVersion of the Masterpage. Default = 15 + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.File + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPMasterPage -SourceFilePath "page.master" -Title "MasterPage" -Description "MasterPage for Web" -DestinationFolderHierarchy "SubFolder" + + Adds a MasterPage from the local file "page.master" to the folder "SubFolder" in the Masterpage gallery. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPNavigationNode + + Adds an item to a navigation element + + + + + Add + PnPNavigationNode + + + + Adds a menu item to either the quicklaunch or top navigation + + + + Add-PnPNavigationNode + + Location + + The location of the node to add. Either TopNavigationBar, QuickLaunch, SearchNav + + NavigationType + + + Title + + The title of the node to add + + String + + + Url + + The url to navigate to when clicking the new menu item. This can either be absolute or relative to the Web. Fragments are not supported. + + String + + + Header + + Optionally value of a header entry to add the menu item to. + + String + + + First + + Add the new menu item to beginning of the collection. + + SwitchParameter + + + External + + Indicates the destination URL is outside of the site collection. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + External + + Indicates the destination URL is outside of the site collection. + + SwitchParameter + + SwitchParameter + + + + + First + + Add the new menu item to beginning of the collection. + + SwitchParameter + + SwitchParameter + + + + + Header + + Optionally value of a header entry to add the menu item to. + + String + + String + + + + + Location + + The location of the node to add. Either TopNavigationBar, QuickLaunch, SearchNav + + NavigationType + + NavigationType + + + + + Title + + The title of the node to add + + String + + String + + + + + Url + + The url to navigate to when clicking the new menu item. This can either be absolute or relative to the Web. Fragments are not supported. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.NavigationNode + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" + + Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPNavigationNode -Title "Contoso USA" -Url "http://contoso.sharepoint.com/sites/contoso/usa/" -Location "QuickLaunch" -Header "Contoso" + + Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso USA", will link to the url "http://contoso.sharepoint.com/sites/contoso/usa/" and will have "Contoso" as a parent navigation node. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -First + + Adds a navigation node to the quicklaunch, as the first item. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/" + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Add-PnPNavigationNode -Title "Contoso Pharmaceuticals" -Url "http://contoso.sharepoint.com/sites/contosopharma/" -Location "QuickLaunch" -External + + Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso Pharmaceuticals" and will link to the external url "http://contoso.sharepoint.com/sites/contosopharma/" + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Add-PnPNavigationNode -Title "Wiki" -Location "QuickLaunch" -Url "wiki/" + + Adds a navigation node to the quicklaunch. The navigation node will have the title "Wiki" and will link to Wiki library on the selected Web. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Test-PnPOffice365GroupAliasIsUsed + + * Supported in: SharePoint Online. + +Tests if a given alias is already used used + + + + + Test + PnPOffice365GroupAliasIsUsed + + + + This command allows you to test if a provided alias is used or free, helps decide if it can be used as part of connecting an Office 365 Unified group to an existing classic site collection. + + + + Test-PnPOffice365GroupAliasIsUsed + + Alias + + Specifies the alias of the group. Cannot contain spaces. + + String + + + 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. + + SPOnlineConnection + + + + + + Alias + + Specifies the alias of the group. Cannot contain spaces. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Test-PnPOffice365GroupAliasIsUsed -Alias "MyGroup" + + This will test if the alias MyGroup is already used + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPOffice365GroupToSite + + * Supported in: SharePoint Online. + +Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group + + + + + Add + PnPOffice365GroupToSite + + + + This command allows you to add an Office 365 Unified group to an existing classic site collection. + + + + Add-PnPOffice365GroupToSite + + Url + + Url of the site to be connected to an Office 365 Group. + + String + + + Alias + + Specifies the alias of the group. Cannot contain spaces. + + String + + + DisplayName + + The display name of the group. + + String + + + Description + + The optional description of the group. + + String + + + Classification + + Specifies the classification of the group. + + String + + + IsPublic + + Specifies if the group is public. Defaults to false. + + SwitchParameter + + + KeepOldHomePage + + Specifies if the current site home page is kept. Defaults to false. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Alias + + Specifies the alias of the group. Cannot contain spaces. + + String + + String + + + + + Classification + + Specifies the classification of the group. + + String + + String + + + + + Description + + The optional description of the group. + + String + + String + + + + + DisplayName + + The display name of the group. + + String + + String + + + + + IsPublic + + Specifies if the group is public. Defaults to false. + + SwitchParameter + + SwitchParameter + + + + + KeepOldHomePage + + Specifies if the current site home page is kept. Defaults to false. + + SwitchParameter + + SwitchParameter + + + + + Url + + Url of the site to be connected to an Office 365 Group. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" -Alias "FinanceTeamsite" -DisplayName = "My finance team site group" + + This will add a group called MyGroup to the current site collection + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPPublishingImageRendition + + Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name. + + + + + Add + PnPPublishingImageRendition + + + + + Add-PnPPublishingImageRendition + + Name + + The display name of the Image Rendition. + + String + + + Width + + The width of the Image Rendition. + + Int32 + + + Height + + The height of the Image Rendition. + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Height + + The height of the Image Rendition. + + Int32 + + Int32 + + + + + Name + + The display name of the Image Rendition. + + String + + String + + + + + Width + + The width of the Image Rendition. + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600 + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPPublishingPage + + Adds a publishing page + + + + + Add + PnPPublishingPage + + + + + Add-PnPPublishingPage + + PageName + + The name of the page to be added as an aspx file + + String + + + PageTemplateName + + The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage' + + String + + + Title + + The title of the page + + String + + + FolderPath + + The site relative folder path of the page to be added + + String + + + Publish + + Publishes the page. Also Approves it if moderation is enabled on the Pages library. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + FolderPath + + The site relative folder path of the page to be added + + String + + String + + + + + PageName + + The name of the page to be added as an aspx file + + String + + String + + + + + PageTemplateName + + The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage' + + String + + String + + + + + Publish + + Publishes the page. Also Approves it if moderation is enabled on the Pages library. + + SwitchParameter + + SwitchParameter + + + + + Title + + The title of the page + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' + + Creates a new page based on the pagelayout 'ArticleLeft' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' -Folder '/Pages/folder' + + Creates a new page based on the pagelayout 'ArticleLeft' with a site relative folder path + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPPublishingPageLayout + + Adds a publishing page layout + + + + + Add + PnPPublishingPageLayout + + + + + Add-PnPPublishingPageLayout + + SourceFilePath + + Path to the file which will be uploaded + + String + + + Title + + Title for the page layout + + String + + + Description + + Description for the page layout + + String + + + AssociatedContentTypeID + + Associated content type ID + + String + + + DestinationFolderHierarchy + + Folder hierarchy where the html page layouts will be deployed + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AssociatedContentTypeID + + Associated content type ID + + String + + String + + + + + Description + + Description for the page layout + + String + + String + + + + + DestinationFolderHierarchy + + Folder hierarchy where the html page layouts will be deployed + + String + + String + + + + + SourceFilePath + + Path to the file which will be uploaded + + String + + String + + + + + Title + + Title for the page layout + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 + + Uploads the pagelayout 'customlayout.aspx' to the current site as a 'web part page' pagelayout + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPRoleDefinition + + Adds a Role Defintion (Permission Level) to the site collection in the current context + + + + + Add + PnPRoleDefinition + + + + This command allows adding a custom Role Defintion (Permission Level) to the site collection in the current context. It does not replace or remove existing Role Definitions. + + + + Add-PnPRoleDefinition + + RoleName + + Name of new permission level. + + String + + + Clone + + An existing permission level or the name of an permission level to clone as base template. + + RoleDefinitionPipeBind + + + Include + + Specifies permission flags(s) to enable. + + PermissionKind[] + + + Exclude + + Specifies permission flags(s) to disable. + + PermissionKind[] + + + Description + + Optional description for the new permission level. + + String + + + 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. + + SPOnlineConnection + + + + + + Clone + + An existing permission level or the name of an permission level to clone as base template. + + RoleDefinitionPipeBind + + RoleDefinitionPipeBind + + + + + Description + + Optional description for the new permission level. + + String + + String + + + + + Exclude + + Specifies permission flags(s) to disable. + + PermissionKind[] + + PermissionKind[] + + + + + Include + + Specifies permission flags(s) to enable. + + PermissionKind[] + + PermissionKind[] + + + + + RoleName + + Name of new permission level. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPRoleDefinition -RoleName "CustomPerm" + + Creates additional permission level with no permission flags enabled. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPRoleDefinition -RoleName "NoDelete" -Clone "Contribute" -Exclude DeleteListItems + + Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPRoleDefinition -RoleName "AddOnly" -Clone "Contribute" -Exclude DeleteListItems, EditListItems + + Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS> $roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" +PS:> Add-PnPRoleDefinition -RoleName "AddOnly" -Clone $roleDefinition -Exclude DeleteListItems, EditListItems + + Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPSiteClassification + + * Supported in: SharePoint Online. + +Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph. + + + + + Add + PnPSiteClassification + + + + + Add-PnPSiteClassification + + Classifications + + + + String + + + + + + Classifications + + + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Add-PnPSiteClassification -Classifications "Top Secret" + + Adds the "Top Secret" classification to the already existing classification values. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Add-PnPSiteClassification -Classifications "Top Secret","HBI" + + Adds the "Top Secret" and the "For Your Eyes Only" classification to the already existing classification values. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPSiteCollectionAdmin + + Adds one or more users as site collection administrators to the site collection in the current context + + + + + Add + PnPSiteCollectionAdmin + + + + This command allows adding one to many users as site collection administrators to the site collection in the current context. It does not replace or remove exisitng site collection administrators. + + + + Add-PnPSiteCollectionAdmin + + Owners + + Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators to the site in the current context. Existing administrators will stay. Can be both users and groups. + + UserPipeBind + + + 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. + + SPOnlineConnection + + + + + + Owners + + Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators to the site in the current context. Existing administrators will stay. Can be both users and groups. + + UserPipeBind + + UserPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com" + + This will add user@contoso.onmicrosoft.com as an additional site collection owner to the site collection in the current context + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") + + This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners to the site collection in the current context + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPUser | ? Title -Like "*Doe" | Add-PnPSiteCollectionAdmin + + This will add all users with their title ending with "Doe" as additional site collection owners to the site collection in the current context + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPSiteCollectionAppCatalog + + * Supported in: SharePoint Online. + +Adds a Site Collection scoped App Catalog to a site + + + + + Add + PnPSiteCollectionAppCatalog + + + + + Add-PnPSiteCollectionAppCatalog + + Site + + Url of the site to add the app catalog to. + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + Site + + Url of the site to add the app catalog to. + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPOffice365GroupToSite -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite" + + This will add a SiteCollection app catalog to the specified site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPSiteDesign + + * Supported in: SharePoint Online. + +Creates a new Site Design on the current tenant. + + + + + Add + PnPSiteDesign + + + + + Add-PnPSiteDesign + + Title + + The title of the site design + + String + + + SiteScriptIds + + An array of guids of site scripts + + GuidPipeBind[] + + + WebTemplate + + Specifies the type of site to which this design applies + + SiteWebTemplate + + + Description + + The description of the site design + + String + + + IsDefault + + Specifies if the site design is a default site design + + SwitchParameter + + + PreviewImageAltText + + Sets the text for the preview image + + String + + + PreviewImageUrl + + Sets the url to the preview image + + String + + + 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. + + SPOnlineConnection + + + + + + Description + + The description of the site design + + String + + String + + + + + IsDefault + + Specifies if the site design is a default site design + + SwitchParameter + + SwitchParameter + + + + + PreviewImageAltText + + Sets the text for the preview image + + String + + String + + + + + PreviewImageUrl + + Sets the url to the preview image + + String + + String + + + + + SiteScriptIds + + An array of guids of site scripts + + GuidPipeBind[] + + GuidPipeBind[] + + + + + Title + + The title of the site design + + String + + String + + + + + WebTemplate + + Specifies the type of site to which this design applies + + SiteWebTemplate + + SiteWebTemplate + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite + + Adds a new Site Design, with the specified title and description. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to Team Sites. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPSiteScript + + * Supported in: SharePoint Online. + +Creates a new Site Script on the current tenant. + + + + + Add + PnPSiteScript + + + + + Add-PnPSiteScript + + Title + + The title of the site script + + String + + + Content + + A JSON string containing the site script + + String + + + Description + + The description of the site script + + String + + + 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. + + SPOnlineConnection + + + + + + Content + + A JSON string containing the site script + + String + + String + + + + + Description + + The description of the site script + + String + + String + + + + + Title + + The title of the site script + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPSiteScript -Title "My Site Script" -Description "A more detailed description" -Content $script + + Adds a new Site Script, where $script variable contains the script. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPStoredCredential + + Adds a credential to the Windows Credential Manager + + + + + Add + PnPStoredCredential + + + + Adds an entry to the Windows Credential Manager. If you add an entry in the form of the URL of your tenant/server PnP PowerShell will check if that entry is available when you connect using Connect-PnPOnline. If it finds a matching URL it will use the associated credentials. + +If you add a Credential with a name of "https://yourtenant.sharepoint.com" it will find a match when you connect to "https://yourtenant.sharepoint.com" but also when you connect to "https://yourtenant.sharepoint.com/sites/demo1". Of course you can specify more granular entries, allow you to automatically provide credentials for different URLs. + + + + Add-PnPStoredCredential + + Name + + The credential to set + + String + + + Username + + + + String + + + Password + + If not specified you will be prompted to enter your password. +If you want to specify this value use ConvertTo-SecureString -String 'YourPassword' -AsPlainText -Force + + SecureString + + + + + + Name + + The credential to set + + String + + String + + + + + Password + + If not specified you will be prompted to enter your password. +If you want to specify this value use ConvertTo-SecureString -String 'YourPassword' -AsPlainText -Force + + SecureString + + SecureString + + + + + Username + + + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com + + You will be prompted to specify the password and a new entry will be added with the specified values + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) + + A new entry will be added with the specified values + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) +Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/mydemosite + + A new entry will be added with the specified values, and a subsequent connection to a sitecollection starting with the entry name will be made. Notice that no password prompt will occur. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPTaxonomyField + + Add a taxonomy field + + + + + Add + PnPTaxonomyField + + + + Adds a taxonomy/managed metadata field to a list or as a site column. + + + + Add-PnPTaxonomyField + + DisplayName + + The display name of the field + + String + + + InternalName + + The internal name of the field + + String + + + TaxonomyItemId + + The ID of the Taxonomy item + + GuidPipeBind + + + List + + The list object or name where this field needs to be added + + ListPipeBind + + + Group + + The group name to where this field belongs to + + String + + + Id + + The ID for the field, must be unique + + GuidPipeBind + + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + + MultiValue + + Switch Parameter if this Taxonomy field can hold multiple values + + SwitchParameter + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + + FieldOptions + + Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details + + AddFieldOptions + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPTaxonomyField + + TermSetPath + + The path to the term that this needs be be bound + + String + + + DisplayName + + The display name of the field + + String + + + InternalName + + The internal name of the field + + String + + + TermPathDelimiter + + The path delimiter to be used, by default this is '|' + + String + + + List + + The list object or name where this field needs to be added + + ListPipeBind + + + Group + + The group name to where this field belongs to + + String + + + Id + + The ID for the field, must be unique + + GuidPipeBind + + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + + MultiValue + + Switch Parameter if this Taxonomy field can hold multiple values + + SwitchParameter + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + + FieldOptions + + Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details + + AddFieldOptions + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddToDefaultView + + Switch Parameter if this field must be added to the default view + + SwitchParameter + + SwitchParameter + + + + + DisplayName + + The display name of the field + + String + + String + + + + + FieldOptions + + Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details + + AddFieldOptions + + AddFieldOptions + + + + + Group + + The group name to where this field belongs to + + String + + String + + + + + Id + + The ID for the field, must be unique + + GuidPipeBind + + GuidPipeBind + + + + + InternalName + + The internal name of the field + + String + + String + + + + + List + + The list object or name where this field needs to be added + + ListPipeBind + + ListPipeBind + + + + + MultiValue + + Switch Parameter if this Taxonomy field can hold multiple values + + SwitchParameter + + SwitchParameter + + + + + Required + + Switch Parameter if the field is a required field + + SwitchParameter + + SwitchParameter + + + + + TaxonomyItemId + + The ID of the Taxonomy item + + GuidPipeBind + + GuidPipeBind + + + + + TermPathDelimiter + + The path delimiter to be used, by default this is '|' + + String + + String + + + + + TermSetPath + + The path to the term that this needs be be bound + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPTaxonomyField -DisplayName "Test" -InternalName "Test" -TermSetPath "TestTermGroup|TestTermSet" + + Adds a new taxonomy field called "Test" that points to the TestTermSet which is located in the TestTermGroup + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPTenantCdnOrigin + + * Supported in: SharePoint Online. + +Adds a new origin to the public or private content delivery network (CDN). + + + + + Add + PnPTenantCdnOrigin + + + + Add a new origin to the public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN. + +You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet. + + + + Add-PnPTenantCdnOrigin + + OriginUrl + + Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. + +Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. + + String + + + CdnType + + Specifies the CDN type. The valid values are: public or private. + + SPOTenantCdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + Specifies the CDN type. The valid values are: public or private. + + SPOTenantCdnType + + SPOTenantCdnType + + + + + OriginUrl + + Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. + +Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPTenantCdnOrigin -Url /sites/site/subfolder -CdnType Public + + This example configures a public CDN on site level. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPTenantTheme + + * Supported in: SharePoint Online. + +Adds or updates a theme to the tenant. + + + + + Add + PnPTenantTheme + + + + Adds or updates atheme to the tenant. + + + + Add-PnPTenantTheme + + Identity + + The name of the theme to add or update + + ThemePipeBind + + + Palette + + The palette to add. See examples for more information. + + ThemePalettePipeBind + + + IsInverted + + If the theme is inverted or not + + Boolean + + + 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. + + SPOnlineConnection + + + + + + Identity + + The name of the theme to add or update + + ThemePipeBind + + ThemePipeBind + + + + + IsInverted + + If the theme is inverted or not + + Boolean + + Boolean + + + + + Palette + + The palette to add. See examples for more information. + + ThemePalettePipeBind + + ThemePalettePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $themepalette = @{ + "themePrimary" = "#00ffff"; + "themeLighterAlt" = "#f3fcfc"; + "themeLighter" = "#daffff"; + "themeLight" = "#affefe"; + "themeTertiary" = "#76ffff"; + "themeSecondary" = "#39ffff"; + "themeDarkAlt" = "#00c4c4"; + "themeDark" = "#009090"; + "themeDarker" = "#005252"; + "neutralLighterAlt" = "#f8f8f8"; + "neutralLighter" = "#f4f4f4"; + "neutralLight" = "#eaeaea"; + "neutralQuaternaryAlt" = "#dadada"; + "neutralQuaternary" = "#d0d0d0"; + "neutralTertiaryAlt" = "#c8c8c8"; + "neutralTertiary" = "#a6a6a6"; + "neutralSecondaryAlt" = "#767676"; + "neutralSecondary" = "#666666"; + "neutralPrimary" = "#333"; + "neutralPrimaryAlt" = "#3c3c3c"; + "neutralDark" = "#212121"; + "black" = "#000000"; + "white" = "#fff"; + "primaryBackground" = "#fff"; + "primaryText" = "#333" + } +PS:>Add-PnPTenantTheme -Identity "MyCompanyTheme" -Palette $themepalette -IsInverted $false + + This example adds a theme to the current tenant. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPUserToGroup + + Adds a user to a group + + + + + Add + PnPUserToGroup + + + + + Add-PnPUserToGroup + + LoginName + + The login name of the user + + String + + + Identity + + The group id, group name or group object to add the user to. + + GroupPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPUserToGroup + + Identity + + The group id, group name or group object to add the user to. + + GroupPipeBind + + + EmailAddress + + The email address of the user + + String + + + SendEmail + + + + SwitchParameter + + + EmailBody + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + EmailAddress + + The email address of the user + + String + + String + + + + + EmailBody + + + + String + + String + + + + + Identity + + The group id, group name or group object to add the user to. + + GroupPipeBind + + GroupPipeBind + + + + + LoginName + + The login name of the user + + String + + String + + + + + SendEmail + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPUserToGroup -LoginName user@company.com -Identity 'Marketing Site Members' + + Add the specified user to the group "Marketing Site Members" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPUserToGroup -LoginName user@company.com -Identity 5 + + Add the specified user to the group with Id 5 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPView + + Adds a view to a list + + + + + Add + PnPView + + + + + Add-PnPView + + Title + + The title of the view. + + String + + + Fields + + A list of fields to add. + + String[] + + + List + + The ID or Url of the list. + + ListPipeBind + + + Query + + A valid CAML Query. + + String + + + ViewType + + The type of view to add. + + ViewType + + + RowLimit + + The row limit for the view. Defaults to 30. + + UInt32 + + + Personal + + If specified, a personal view will be created. + + SwitchParameter + + + SetAsDefault + + If specified, the view will be set as the default view for the list. + + SwitchParameter + + + Paged + + If specified, the view will have paging. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Fields + + A list of fields to add. + + String[] + + String[] + + + + + List + + The ID or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + Paged + + If specified, the view will have paging. + + SwitchParameter + + SwitchParameter + + + + + Personal + + If specified, a personal view will be created. + + SwitchParameter + + SwitchParameter + + + + + Query + + A valid CAML Query. + + String + + String + + + + + RowLimit + + The row limit for the view. Defaults to 30. + + UInt32 + + UInt32 + + + + + SetAsDefault + + If specified, the view will be set as the default view for the list. + + SwitchParameter + + SwitchParameter + + + + + Title + + The title of the view. + + String + + String + + + + + ViewType + + The type of view to add. + + ViewType + + ViewType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.View + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" + + Adds a view named "Demo view" to the "Demo List" list. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Paged + + Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWebhookSubscription + + * Supported in: SharePoint Online. + +Adds a new Webhook subscription + + + + + Add + PnPWebhookSubscription + + + + + Add-PnPWebhookSubscription + + NotificationUrl + + The URL of the Webhook endpoint that will be notified of the change + + String + + + List + + The list object or name where the Webhook subscription will be added to + + ListPipeBind + + + ExpirationDate + + The date at which the Webhook subscription will expire. (Default: 6 months from today) + + DateTime + + + ClientState + + A client state information that will be passed through notifications + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ClientState + + A client state information that will be passed through notifications + + String + + String + + + + + ExpirationDate + + The date at which the Webhook subscription will expire. (Default: 6 months from today) + + DateTime + + DateTime + + + + + List + + The list object or name where the Webhook subscription will be added to + + ListPipeBind + + ListPipeBind + + + + + NotificationUrl + + The URL of the Webhook endpoint that will be notified of the change + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.WebhookSubscription + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook + + Add a Webhook subscription for the specified notification Url on the list MyList + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" + + Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -ClientState "Hello State!" + + Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 with a specific client state + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWebPartToWebPartPage + + Adds a webpart to a web part page in a specified zone + + + + + Add + PnPWebPartToWebPartPage + + + + + Add-PnPWebPartToWebPartPage + + Xml + + A string containing the XML for the webpart. + + String + + + ServerRelativePageUrl + + Server Relative Url of the page to add the webpart to. + + String + + + ZoneId + + The Zone Id where the webpart must be placed + + String + + + ZoneIndex + + The Zone Index where the webpart must be placed + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPWebPartToWebPartPage + + Path + + A path to a webpart file on a the file system. + + String + + + ServerRelativePageUrl + + Server Relative Url of the page to add the webpart to. + + String + + + ZoneId + + The Zone Id where the webpart must be placed + + String + + + ZoneIndex + + The Zone Index where the webpart must be placed + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Path + + A path to a webpart file on a the file system. + + String + + String + + + + + ServerRelativePageUrl + + Server Relative Url of the page to add the webpart to. + + String + + String + + + + + Xml + + A string containing the XML for the webpart. + + String + + String + + + + + ZoneId + + The Zone Id where the webpart must be placed + + String + + String + + + + + ZoneIndex + + The Zone Index where the webpart must be placed + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 + + This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the specified zone and with the order index of 1 + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 + + This will add the webpart as defined by the XML in the $webpart variable to the specified page in the specified zone and with the order index of 1 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWebPartToWikiPage + + Adds a webpart to a wiki page in a specified table row and column + + + + + Add + PnPWebPartToWikiPage + + + + + Add-PnPWebPartToWikiPage + + Xml + + A string containing the XML for the webpart. + + String + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + + Row + + Row number where the webpart must be placed + + Int32 + + + Column + + Column number where the webpart must be placed + + Int32 + + + AddSpace + + Must there be a extra space between the webpart + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPWebPartToWikiPage + + Path + + A path to a webpart file on a the file system. + + String + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + + Row + + Row number where the webpart must be placed + + Int32 + + + Column + + Column number where the webpart must be placed + + Int32 + + + AddSpace + + Must there be a extra space between the webpart + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddSpace + + Must there be a extra space between the webpart + + SwitchParameter + + SwitchParameter + + + + + Column + + Column number where the webpart must be placed + + Int32 + + Int32 + + + + + Path + + A path to a webpart file on a the file system. + + String + + String + + + + + Row + + Row number where the webpart must be placed + + Int32 + + Int32 + + + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + String + + + + + Xml + + A string containing the XML for the webpart. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -Row 1 -Column 1 + + This will add the webpart as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -Row 1 -Column 1 + + This will add the webpart as defined by the XML in the $webpart variable to the specified page in the first row and the first column of the HTML table present on the page + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWikiPage + + Adds a wiki page + + + + + Add + PnPWikiPage + + + + + Add-PnPWikiPage + + Content + + + + String + + + ServerRelativePageUrl + + The server relative page URL + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Add-PnPWikiPage + + Layout + + + + WikiPageLayout + + + ServerRelativePageUrl + + The server relative page URL + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Content + + + + String + + String + + + + + Layout + + + + WikiPageLayout + + WikiPageLayout + + + + + ServerRelativePageUrl + + The server relative page URL + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWikiPage -PageUrl '/sites/demo1/pages/wikipage.aspx' -Content 'New WikiPage' + + Creates a new wiki page '/sites/demo1/pages/wikipage.aspx' and sets the content to 'New WikiPage' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWorkflowDefinition + + Adds a workflow definition + + + + + Add + PnPWorkflowDefinition + + + + + Add-PnPWorkflowDefinition + + Definition + + The workflow definition to add. + + WorkflowDefinition + + + DoNotPublish + + Overrides the default behaviour, which is to publish workflow definitions. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Definition + + The workflow definition to add. + + WorkflowDefinition + + WorkflowDefinition + + + + + DoNotPublish + + Overrides the default behaviour, which is to publish workflow definitions. + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.Guid + + + Returns the Id of the workflow definition + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWorkflowDefinition -Definition $wfdef + + Adds an existing workflow definition, retrieved by Get-PnPWorkflowDefinition, to a site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Add-PnPWorkflowSubscription + + Adds a workflow subscription to a list + + + + + Add + PnPWorkflowSubscription + + + + + Add-PnPWorkflowSubscription + + Name + + The name of the subscription + + String + + + DefinitionName + + The name of the workflow definition + + String + + + List + + The list to add the workflow to + + ListPipeBind + + + HistoryListName + + The name of the History list + + String + + + TaskListName + + The name of the task list + + String + + + StartManually + + Switch if the workflow should be started manually, default value is 'true' + + SwitchParameter + + + StartOnCreated + + Should the workflow run when an new item is created + + SwitchParameter + + + StartOnChanged + + Should the workflow run when an item is changed + + SwitchParameter + + + AssociationValues + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AssociationValues + + + + String + + String + + + + + DefinitionName + + The name of the workflow definition + + String + + String + + + + + HistoryListName + + The name of the History list + + String + + String + + + + + List + + The list to add the workflow to + + ListPipeBind + + ListPipeBind + + + + + Name + + The name of the subscription + + String + + String + + + + + StartManually + + Switch if the workflow should be started manually, default value is 'true' + + SwitchParameter + + SwitchParameter + + + + + StartOnChanged + + Should the workflow run when an item is changed + + SwitchParameter + + SwitchParameter + + + + + StartOnCreated + + Should the workflow run when an new item is created + + SwitchParameter + + SwitchParameter + + + + + TaskListName + + The name of the task list + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -list $list + + Adds an Workflow with the name 'SendMessageWf' to the list $list. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $list | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf + + Adds an Workflow with the name "SendMessageWf" to the list $list. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPList -Identity "MyCustomList" | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf + + Adds an Workflow with the name "SendMessageWf" to the list "MyCustomList". + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Apply-PnPProvisioningTemplate + + Applies a provisioning template to a web + + + + + Apply + PnPProvisioningTemplate + + + + + Apply-PnPProvisioningTemplate + + InputInstance + + Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template. + + ProvisioningTemplate + + + ResourceFolder + + Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used. + + String + + + OverwriteSystemPropertyBagValues + + Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) + + SwitchParameter + + + IgnoreDuplicateDataRowErrors + + Ignore duplicate data row errors when the data row in the template already exists. + + SwitchParameter + + + ProvisionContentTypesToSubWebs + + If set content types will be provisioned if the target web is a subweb. + + SwitchParameter + + + ProvisionFieldsToSubWebs + + If set fields will be provisioned if the target web is a subweb. + + SwitchParameter + + + ClearNavigation + + Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template + + SwitchParameter + + + Parameters + + 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. + + Hashtable + + + Handlers + + Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. + + Handlers + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while applying a template + + ExtensibilityHandler[] + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while applying a template. + + ITemplateProviderExtension[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Apply-PnPProvisioningTemplate + + GalleryTemplateId + + + + Guid + + + ResourceFolder + + Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used. + + String + + + OverwriteSystemPropertyBagValues + + Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) + + SwitchParameter + + + IgnoreDuplicateDataRowErrors + + Ignore duplicate data row errors when the data row in the template already exists. + + SwitchParameter + + + ProvisionContentTypesToSubWebs + + If set content types will be provisioned if the target web is a subweb. + + SwitchParameter + + + ProvisionFieldsToSubWebs + + If set fields will be provisioned if the target web is a subweb. + + SwitchParameter + + + ClearNavigation + + Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template + + SwitchParameter + + + Parameters + + 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. + + Hashtable + + + Handlers + + Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. + + Handlers + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while applying a template + + ExtensibilityHandler[] + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while applying a template. + + ITemplateProviderExtension[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Apply-PnPProvisioningTemplate + + Path + + Path to the xml or pnp file containing the provisioning template. + + String + + + ResourceFolder + + Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used. + + String + + + OverwriteSystemPropertyBagValues + + Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) + + SwitchParameter + + + IgnoreDuplicateDataRowErrors + + Ignore duplicate data row errors when the data row in the template already exists. + + SwitchParameter + + + ProvisionContentTypesToSubWebs + + If set content types will be provisioned if the target web is a subweb. + + SwitchParameter + + + ProvisionFieldsToSubWebs + + If set fields will be provisioned if the target web is a subweb. + + SwitchParameter + + + ClearNavigation + + Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template + + SwitchParameter + + + Parameters + + 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. + + Hashtable + + + Handlers + + Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. + + Handlers + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while applying a template + + ExtensibilityHandler[] + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while applying a template. + + ITemplateProviderExtension[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ClearNavigation + + Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template + + SwitchParameter + + SwitchParameter + + + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + Handlers + + + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while applying a template + + ExtensibilityHandler[] + + ExtensibilityHandler[] + + + + + GalleryTemplateId + + + + Guid + + Guid + + + + + Handlers + + Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. + + Handlers + + Handlers + + + + + IgnoreDuplicateDataRowErrors + + Ignore duplicate data row errors when the data row in the template already exists. + + SwitchParameter + + SwitchParameter + + + + + InputInstance + + Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template. + + ProvisioningTemplate + + ProvisioningTemplate + + + + + OverwriteSystemPropertyBagValues + + Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) + + SwitchParameter + + SwitchParameter + + + + + Parameters + + 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. + + Hashtable + + Hashtable + + + + + Path + + Path to the xml or pnp file containing the provisioning template. + + String + + String + + + + + ProvisionContentTypesToSubWebs + + If set content types will be provisioned if the target web is a subweb. + + SwitchParameter + + SwitchParameter + + + + + ProvisionFieldsToSubWebs + + If set fields will be provisioned if the target web is a subweb. + + SwitchParameter + + SwitchParameter + + + + + ResourceFolder + + Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used. + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while applying a template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path template.xml + + Applies a provisioning template in XML format to the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path template.xml -ResourceFolder c:\provisioning\resources + + Applies a provisioning template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path template.xml -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"} + + Applies a provisioning template in XML format to the current web. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. + +For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path template.xml -Handlers Lists, SiteSecurity + + Applies a provisioning template in XML format to the current web. It will only apply the lists and site security part of the template. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path template.pnp + + Applies a provisioning template from a pnp package to the current web. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path https://tenant.sharepoint.com/sites/templatestorage/Documents/template.pnp + + Applies a provisioning template from a pnp package stored in a library to the current web. + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + +PS:> $handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 +PS:> $handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 +PS:> Apply-PnPProvisioningTemplate -Path NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2 + + This will create two new ExtensibilityHandler objects that are run while provisioning the template + + + + + + + + + + ------------------EXAMPLE 8--------------------- + + + + PS:> Apply-PnPProvisioningTemplate -Path .\ -InputInstance $template + + Applies a provisioning template from an in-memory instance of a ProvisioningTemplate type of the PnP Core Component, reading the supporting files, if any, from the current (.\) path. The syntax can be used together with any other supported parameters. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSitePolicy + + Sets a site policy + + + + + Set + PnPSitePolicy + + + + + Set-PnPSitePolicy + + Name + + The name of the site policy to apply + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Name + + The name of the site policy to apply + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSitePolicy -Name "Contoso HBI" + + This applies a site policy with the name "Contoso HBI" to the current site. The policy needs to be available in the site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Clear-PnPListItemAsRecord + + * Supported in: SharePoint Online. + +Undeclares a list item as a record + + + + + Clear + PnPListItemAsRecord + + + + + Clear-PnPListItemAsRecord + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Clear-PnPListItemAsRecord -List "Documents" -Identity 4 + + Undeclares the document in the documents library with id 4 as a record + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Clear-PnPRecycleBinItem + + Permanently deletes all or a specific recycle bin item + + + + + Clear + PnPRecycleBinItem + + + + + Clear-PnPRecycleBinItem + + All + + Clears all items + + SwitchParameter + + + SecondStageOnly + + If provided, only all the items in the second stage recycle bin will be cleared + + SwitchParameter + + + Force + + If provided, no confirmation will be asked to permanently delete the recycle bin item + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Clear-PnPRecycleBinItem + + Identity + + Id of the recycle bin item or the recycle bin item itself to permanently delete + + RecycleBinItemPipeBind + + + Force + + If provided, no confirmation will be asked to permanently delete the recycle bin item + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + All + + Clears all items + + SwitchParameter + + SwitchParameter + + + + + Force + + If provided, no confirmation will be asked to permanently delete the recycle bin item + + SwitchParameter + + SwitchParameter + + + + + Identity + + Id of the recycle bin item or the recycle bin item itself to permanently delete + + RecycleBinItemPipeBind + + RecycleBinItemPipeBind + + + + + SecondStageOnly + + If provided, only all the items in the second stage recycle bin will be cleared + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPRecycleBinItems | ? FileLeafName -like "*.docx" | Clear-PnpRecycleBinItem + + Permanently deletes all the items in the first and second stage recycle bins of which the file names have the .docx extension + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Clear-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442 + + Permanently deletes the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 from the recycle bin + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Clear-PnpRecycleBinItem -Identity $item -Force + + Permanently deletes the recycle bin item stored under variable $item from the recycle bin without asking for confirmation from the end user first + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Clear-PnPTenantRecycleBinItem + + Permanently deletes a site collection from the tenant scoped recycle bin + + + + + Clear + PnPTenantRecycleBinItem + + + + The Clear-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be permanently deleted from the recycle bin as well. + + + + Clear-PnPTenantRecycleBinItem + + Url + + Url of the site collection to permanently delete from the tenant recycle bin + + String + + + Wait + + If provided, the PowerShell execution will halt until the operation has completed + + SwitchParameter + + + Force + + If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin + + SwitchParameter + + SwitchParameter + + + + + Url + + Url of the site collection to permanently delete from the tenant recycle bin + + String + + String + + + + + Wait + + If provided, the PowerShell execution will halt until the operation has completed + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso + + This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait + + This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin and will wait with executing further PowerShell commands until the operation has completed + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Connect-PnPOnline + + Connect to a SharePoint site + + + + + Connect + PnPOnline + + + + If no credentials have been specified, and the CurrentCredentials parameter has not been specified, you will be prompted for credentials. + + + + Connect-PnPOnline + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + Credentials + + Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials. + + CredentialPipeBind + + + CurrentCredentials + + If you want to connect with the current user credentials + + SwitchParameter + + + UseAdfs + + If you want to connect to your on-premises SharePoint farm using ADFS + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + AuthenticationMode + + Specify to use for instance use forms based authentication (FBA) + + ClientAuthenticationMode + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + AccessToken + + Connect with an existing Access Token + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + Url + + The Url of the site collection to connect to. + + String + + + + Connect-PnPOnline + + Graph + + Log in using the PnP O365 Management Shell application towards the Graph. You will be asked to consent to: + +* Read and write managed metadata +* Have full control of all site collections +* Read user profiles +* Invite guest users to the organization +* Read and write all groups +* Read and write directory data +* Access the directory as you +* Read and write identity providers +* Access the directory as you + + + SwitchParameter + + + LaunchBrowser + + Launch a browser automatically and copy the code to enter to the clipboard + + SwitchParameter + + + + Connect-PnPOnline + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + + Connect-PnPOnline + + UseWebLogin + + If you want to connect to SharePoint with browser based login + + SwitchParameter + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + SPOManagementShell + + Log in using the SharePoint Online Management Shell application + + SwitchParameter + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + ClearTokenCache + + Clears the token cache. + + SwitchParameter + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + PnPO365ManagementShell + + Log in using the PnP O365 Management Shell application. You will be asked to consent to: + +* Read and write managed metadata +* Have full control of all site collections +* Read user profiles +* Invite guest users to the organization +* Read and write all groups +* Read and write directory data +* Access the directory as you +* Read and write identity providers +* Access the directory as you + + SwitchParameter + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + LaunchBrowser + + Launch a browser automatically and copy the code to enter to the clipboard + + SwitchParameter + + + + Connect-PnPOnline + + AppId + + The Application Client ID to use. + + String + + + AppSecret + + The Application Client Secret to use. + + String + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + Realm + + Authentication realm. If not specified will be resolved from the url specified. + + String + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + ClientId + + The Client ID of the Azure AD Application + + String + + + RedirectUri + + The Redirect URI of the Azure AD Application + + String + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + ClearTokenCache + + Clears the token cache. + + SwitchParameter + + + AzureEnvironment + + The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment. + + AzureEnvironment + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + AppId + + The client id of the app which gives you access to the Microsoft Graph API. + + String + + + AppSecret + + The app key of the app which gives you access to the Microsoft Graph API. + + String + + + AADDomain + + The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. + + String + + + + Connect-PnPOnline + + ClientId + + The Client ID of the Azure AD Application + + String + + + Tenant + + The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com + + String + + + CertificatePath + + Path to the certificate (*.pfx) + + String + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + CertificatePassword + + Password to the certificate (*.pfx) + + SecureString + + + AzureEnvironment + + The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment. + + AzureEnvironment + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + Connect-PnPOnline + + ClientId + + The Client ID of the Azure AD Application + + String + + + Tenant + + The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com + + String + + + PEMCertificate + + PEM encoded certificate + + String + + + PEMPrivateKey + + PEM encoded private key for the certificate + + String + + + Url + + The Url of the site collection to connect to. + + String + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + + CertificatePassword + + Password to the certificate (*.pfx) + + SecureString + + + AzureEnvironment + + The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment. + + AzureEnvironment + + + TenantAdminUrl + + 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. + + String + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + + + + + AADDomain + + The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. + + String + + String + + + + + AccessToken + + Connect with an existing Access Token + + String + + String + + + + + AppId + + The Application Client ID to use. + + String + + String + + + + + AppSecret + + The Application Client Secret to use. + + String + + String + + + + + AuthenticationMode + + Specify to use for instance use forms based authentication (FBA) + + ClientAuthenticationMode + + ClientAuthenticationMode + + + + + AzureEnvironment + + The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment. + + AzureEnvironment + + AzureEnvironment + + + + + CertificatePassword + + Password to the certificate (*.pfx) + + SecureString + + SecureString + + + + + CertificatePath + + Path to the certificate (*.pfx) + + String + + String + + + + + ClearTokenCache + + Clears the token cache. + + SwitchParameter + + SwitchParameter + + + + + ClientId + + The Client ID of the Azure AD Application + + String + + String + + + + + CreateDrive + + If you want to create a PSDrive connected to the URL + + SwitchParameter + + SwitchParameter + + + + + Credentials + + Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials. + + CredentialPipeBind + + CredentialPipeBind + + + + + CurrentCredentials + + If you want to connect with the current user credentials + + SwitchParameter + + SwitchParameter + + + + + DriveName + + Name of the PSDrive to create (default: SPO) + + String + + String + + + + + Graph + + Log in using the PnP O365 Management Shell application towards the Graph. You will be asked to consent to: + +* Read and write managed metadata +* Have full control of all site collections +* Read user profiles +* Invite guest users to the organization +* Read and write all groups +* Read and write directory data +* Access the directory as you +* Read and write identity providers +* Access the directory as you + + + SwitchParameter + + SwitchParameter + + + + + IgnoreSslErrors + + Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine. + + SwitchParameter + + SwitchParameter + + + + + LaunchBrowser + + Launch a browser automatically and copy the code to enter to the clipboard + + SwitchParameter + + SwitchParameter + + + + + MinimalHealthScore + + Specifies a minimal server healthscore before any requests are executed. + + Int32 + + Int32 + + + + + PEMCertificate + + PEM encoded certificate + + String + + String + + + + + PEMPrivateKey + + PEM encoded private key for the certificate + + String + + String + + + + + PnPO365ManagementShell + + Log in using the PnP O365 Management Shell application. You will be asked to consent to: + +* Read and write managed metadata +* Have full control of all site collections +* Read user profiles +* Invite guest users to the organization +* Read and write all groups +* Read and write directory data +* Access the directory as you +* Read and write identity providers +* Access the directory as you + + SwitchParameter + + SwitchParameter + + + + + Realm + + Authentication realm. If not specified will be resolved from the url specified. + + String + + String + + + + + RedirectUri + + The Redirect URI of the Azure AD Application + + String + + String + + + + + RequestTimeout + + The request timeout. Default is 180000 + + Int32 + + Int32 + + + + + RetryCount + + Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times. + + Int32 + + Int32 + + + + + RetryWait + + Defines how many seconds to wait before each retry. Default is 1 second. + + Int32 + + Int32 + + + + + ReturnConnection + + Returns the connection for use with the -Connection parameter on cmdlets. + + SwitchParameter + + SwitchParameter + + + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + String[] + + + + + SkipTenantAdminCheck + + Should we skip the check if this site is the Tenant admin site. Default is false + + SwitchParameter + + SwitchParameter + + + + + SPOManagementShell + + Log in using the SharePoint Online Management Shell application + + SwitchParameter + + SwitchParameter + + + + + Tenant + + The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com + + String + + String + + + + + TenantAdminUrl + + 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. + + String + + String + + + + + Url + + The Url of the site collection to connect to. + + String + + String + + + + + UseAdfs + + If you want to connect to your on-premises SharePoint farm using ADFS + + SwitchParameter + + SwitchParameter + + + + + UseWebLogin + + If you want to connect to SharePoint with browser based login + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com + + This will prompt for username and password and creates a context for the other PowerShell commands to use. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential) + + This will prompt for username and password and creates a context for the other PowerShell commands to use. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Connect-PnPOnline -Url http://yourlocalserver -CurrentCredentials + + This will use the current user credentials and connects to the server specified by the Url parameter. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Connect-PnPOnline -Url http://yourlocalserver -Credentials 'O365Creds' + + This will use credentials from the Windows Credential Manager, as defined by the label 'O365Creds'. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Connect-PnPOnline -Url http://yourlocalserver -Credentials (Get-Credential) -UseAdfs + + This will prompt for username and password and creates a context using ADFS to authenticate. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive +PS:> cd SPO:\\ +PS:> dir + + This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\\ drive you can use to navigate around the site + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication + + This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA) + + + + + + + + + + ------------------EXAMPLE 8--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany + + This will authenticate you to the German Azure environment using the German Azure endpoints for authentication + + + + + + + + + + ------------------EXAMPLE 9--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -SPOManagementShell + + This will authenticate you using the SharePoint Online Management Shell application + + + + + + + + + + ------------------EXAMPLE 10--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell + + This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will have to be opened where you have to enter a code that is shown in your PowerShell window. + + + + + + + + + + ------------------EXAMPLE 11--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -LaunchBrowser + + This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard. + + + + + + + + + + ------------------EXAMPLE 12--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -AccessToken $myaccesstoken + + This will authenticate you using the provided access token + + + + + + + + + + ------------------EXAMPLE 13--------------------- + + + + PS:> Connect-PnPOnline -Scopes $arrayOfScopes + + Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://graph.microsoft.io/en-us/docs/authorization/permission_scopes + + + + + + + + + + ------------------EXAMPLE 14--------------------- + + + + PS:> Connect-PnPOnline -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com' + + Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started. + + + + + + + + + + ------------------EXAMPLE 15--------------------- + + + + PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate <PEM string> -PEMPrivateKey <PEM string> + + Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Connect-PnPMicrosoftGraph + + Connect to the Microsoft Graph + + + + + Connect + PnPMicrosoftGraph + + + + Uses the Microsoft Authentication Library (Preview) to connect to Azure AD and to get an OAuth 2.0 Access Token to consume the Microsoft Graph API + + + + Connect-PnPMicrosoftGraph + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + + + Connect-PnPMicrosoftGraph + + AppId + + The client id of the app which gives you access to the Microsoft Graph API. + + String + + + AppSecret + + The app key of the app which gives you access to the Microsoft Graph API. + + String + + + AADDomain + + The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. + + String + + + + + + AADDomain + + The AAD where the O365 app is registred. Eg.: contoso.com, or contoso.onmicrosoft.com. + + String + + String + + + + + AppId + + The client id of the app which gives you access to the Microsoft Graph API. + + String + + String + + + + + AppSecret + + The app key of the app which gives you access to the Microsoft Graph API. + + String + + String + + + + + Scopes + + The array of permission scopes for the Microsoft Graph API. + + String[] + + String[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPMicrosoftGraph -Scopes $arrayOfScopes + + Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://graph.microsoft.io/en-us/docs/authorization/permission_scopes + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPMicrosoftGraph -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com' + + Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Convert-PnPProvisioningTemplate + + Converts a provisioning template to an other schema version + + + + + Convert + PnPProvisioningTemplate + + + + + Convert-PnPProvisioningTemplate + + Path + + Path to the xml file containing the provisioning template + + String + + + Out + + Filename to write to, optionally including full path + + String + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + + Force + + Overwrites the output file if it exists + + SwitchParameter + + + ToSchema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + + + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + Encoding + + + + + Force + + Overwrites the output file if it exists + + SwitchParameter + + SwitchParameter + + + + + Out + + Filename to write to, optionally including full path + + String + + String + + + + + Path + + Path to the xml file containing the provisioning template + + String + + String + + + + + ToSchema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + XMLPnPSchemaVersion + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Convert-PnPProvisioningTemplate -Path template.xml + + Converts a provisioning template to the latest schema and outputs the result to current console. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml + + Converts a provisioning template to the latest schema and outputs the result the newtemplate.xml file. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml -ToSchema V201512 + + Converts a provisioning template to the latest schema using the 201512 schema and outputs the result the newtemplate.xml file. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Encoding: + https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx + + + + + + Convert-PnPFolderToProvisioningTemplate + + Creates a pnp package file of an existing template xml, and includes all files in the current folder + + + + + Convert + PnPFolderToProvisioningTemplate + + + + + Convert-PnPFolderToProvisioningTemplate + + Out + + Filename to write to, optionally including full path. + + String + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + Folder + + Folder to process. If not specified the current folder will be used. + + String + + + + + + Folder + + Folder to process. If not specified the current folder will be used. + + String + + String + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + Out + + Filename to write to, optionally including full path. + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Convert-PnPFolderToProvisioningTemplate -Out template.pnp + + Creates a pnp package file of an existing template xml, and includes all files in the current folder + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Convert-PnPFolderToProvisioningTemplate -Out template.pnp -Folder c:\temp + + Creates a pnp package file of an existing template xml, and includes all files in the c:\temp folder + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Copy-PnPFile + + Copies a file or folder to a different location + + + + + Copy + PnPFile + + + + + Copy-PnPFile + + SourceUrl + + Site relative Url specifying the file or folder to copy. + + String + + + TargetUrl + + Server relative Url where to copy the file or folder to. + + String + + + OverwriteIfAlreadyExists + + If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the copy operation will be canceled if the file already exists at the TargetUrl location. + + SwitchParameter + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + + SkipSourceFolderName + + If the source is a folder, the source folder name will not be created, only the contents within it. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + SwitchParameter + + + + + OverwriteIfAlreadyExists + + If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the copy operation will be canceled if the file already exists at the TargetUrl location. + + SwitchParameter + + SwitchParameter + + + + + SkipSourceFolderName + + If the source is a folder, the source folder name will not be created, only the contents within it. + + SwitchParameter + + SwitchParameter + + + + + SourceUrl + + Site relative Url specifying the file or folder to copy. + + String + + String + + + + + TargetUrl + + Server relative Url where to copy the file or folder to. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx + + Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it won't perform the copy. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents/company2.docx + + Copies a file named company.docx located in a document library called Documents to a new document named company2.docx in the same library. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents2/company.docx + + Copies a file named company.docx located in a document library called Documents to a document library called Documents2 in the same site. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents/company2.docx + + Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite as a new document named company2.docx. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents + + Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite keeping the file name. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists + + Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it will still perform the copy and replace the original company.docx file. + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -OverwriteIfAlreadyExists + + Copies a folder named MyDocs in the document library called Documents located in the current site to the site collection otherproject. If the MyDocs folder exist it will copy into it, if not it will be created. + + + + + + + + + + ------------------EXAMPLE 8--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -SkipSourceFolderName -OverwriteIfAlreadyExists + + Copies a folder named MyDocs in the document library called Documents located in the current site to the root folder of the library named Documents in the site collection otherproject. + + + + + + + + + + ------------------EXAMPLE 9--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -SkipSourceFolderName -OverwriteIfAlreadyExists + + Copies a folder named MyDocs in the MyDocs folder of the library named Documents. If the MyDocs folder does not exists, it will be created. + + + + + + + + + + ------------------EXAMPLE 10--------------------- + + + + PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -OverwriteIfAlreadyExists + + Copies a folder named MyDocs in the root of the library named Documents. If the MyDocs folder exists in the target, a subfolder also named MyDocs is created. + + + + + + + + + + ------------------EXAMPLE 11--------------------- + + + + PS:>Copy-PnPFile -SourceUrl SubSite1/Documents/company.docx -TargetUrl SubSite2/Documents + + Copies a file named company.docx in the library named Documents in SubSite1 to the library named Documents in SubSite2. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Disable-PnPFeature + + Disables a feature + + + + + Disable + PnPFeature + + + + Deactives a feature that was active on a site + + + + Disable-PnPFeature + + Identity + + The id of the feature to disable. + + GuidPipeBind + + + Force + + Specifies whether to continue if an error occurs when deactivating the feature. + + SwitchParameter + + + Scope + + Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web. + + FeatureScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifies whether to continue if an error occurs when deactivating the feature. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The id of the feature to disable. + + GuidPipeBind + + GuidPipeBind + + + + + Scope + + Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web. + + FeatureScope + + FeatureScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force + + This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web + + This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Disable-PnPInPlaceRecordsManagementForSite + + Disables in place records management for a site. + + + + + Disable + PnPInPlaceRecordsManagementForSite + + + + + Disable-PnPInPlaceRecordsManagementForSite + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Disable-PnPInPlaceRecordsManagementForSite + + The in place records management feature will be disabled + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Disable-PnPResponsiveUI + + Deactive the PnP Response UI add-on + + + + + Disable + PnPResponsiveUI + + + + Disables the PnP Responsive UI implementation on a classic SharePoint Site + + + + Disable-PnPResponsiveUI + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Disable-PnPResponsiveUI + + If enabled previously, this will remove the PnP Responsive UI from a site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Disable-PnPSiteClassification + + * Supported in: SharePoint Online. + +Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph. + + + + + Disable + PnPSiteClassification + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Disable-PnPSiteClassification + + Disables Site Classifications for your tenant. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Disconnect-PnPOnline + + Disconnects the context + + + + + Disconnect + PnPOnline + + + + Disconnects the current context and requires you to build up a new connection in order to use the Cmdlets again. Using Connect-PnPOnline to connect to a different site has the same effect. + + + + Disconnect-PnPOnline + + Connection + + Connection to be used by cmdlet + + SPOnlineConnection + + + + + + Connection + + Connection to be used by cmdlet + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Disconnect-PnPOnline + + This will disconnect you from the server. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Enable-PnPFeature + + Enables a feature + + + + + Enable + PnPFeature + + + + + Enable-PnPFeature + + Identity + + The id of the feature to enable. + + GuidPipeBind + + + Force + + Specifies whether to overwrite an existing feature with the same feature identifier. This parameter is ignored if there are no errors. + + SwitchParameter + + + Scope + + Specify the scope of the feature to activate, either Web or Site. Defaults to Web. + + FeatureScope + + + Sandboxed + + Specify this parameter if the feature you're trying to activate is part of a sandboxed solution. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifies whether to overwrite an existing feature with the same feature identifier. This parameter is ignored if there are no errors. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The id of the feature to enable. + + GuidPipeBind + + GuidPipeBind + + + + + Sandboxed + + Specify this parameter if the feature you're trying to activate is part of a sandboxed solution. + + SwitchParameter + + SwitchParameter + + + + + Scope + + Specify the scope of the feature to activate, either Web or Site. Defaults to Web. + + FeatureScope + + FeatureScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force + + This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web + + This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Enable-PnPInPlaceRecordsManagementForSite + + Enables in place records management for a site. + + + + + Enable + PnPInPlaceRecordsManagementForSite + + + + + Enable-PnPInPlaceRecordsManagementForSite + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Enable-PnPInPlaceRecordsManagementForSite + + The in place records management feature will be enabled and the in place record management will be enabled in all locations with record declaration allowed by all contributors and undeclaration by site admins + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Enable-PnPResponsiveUI + + Activates the PnP Response UI Add-on + + + + + Enable + PnPResponsiveUI + + + + Enables the PnP Responsive UI implementation on a classic SharePoint Site + + + + Enable-PnPResponsiveUI + + InfrastructureSiteUrl + + A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + InfrastructureSiteUrl + + A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Enable-PnPResponsiveUI + + Will upload a CSS file, a JavaScript file and adds a custom action to the root web of the current site collection, enabling the responsive UI on the site collection. The CSS and JavaScript files are located in the style library, in a folder called SP.Responsive.UI. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Enable-PnPSiteClassification + + * Supported in: SharePoint Online. + +Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph. + + + + + Enable + PnPSiteClassification + + + + + Enable-PnPSiteClassification + + Classifications + + + + String + + + DefaultClassification + + + + String + + + UsageGuidelinesUrl + + + + String + + + + + + Classifications + + + + String + + String + + + + + DefaultClassification + + + + String + + String + + + + + UsageGuidelinesUrl + + + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -DefaultClassification "LBI" + + Enables Site Classifications for your tenant and provides three classification values. The default value will be set to "LBI" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -UsageGuidelinesUrl http://aka.ms/sppnp + + Enables Site Classifications for your tenant and provides three classification values. The usage guideliness will be set to the specified URL. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPProperty + + Returns a previously not loaded property of a ClientObject + + + + + Get + PnPProperty + + + + Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output. + + + + Get-PnPProperty + + ClientObject + + Specifies the object where the properties of should be retrieved + + ClientObject + + + Property + + The properties to load. If one property is specified its value will be returned to the output. + + String[] + + + 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. + + SPOnlineConnection + + + + + + ClientObject + + Specifies the object where the properties of should be retrieved + + ClientObject + + ClientObject + + + + + Property + + The properties to load. If one property is specified its value will be returned to the output. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.ClientObject + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + +PS:> $web = Get-PnPWeb +PS:> Get-PnPProperty -ClientObject $web -Property Id, Lists +PS:> $web.Lists + + Will load both the Id and Lists properties of the specified Web object. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + +PS:> $list = Get-PnPList -Identity 'Site Assets' +PS:> Get-PnPProperty -ClientObject $list -Property Views + + Will load the views object of the specified list object and return its value to the output. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Export-PnPTaxonomy + + Exports a taxonomy to either the output or to a file. + + + + + Export + PnPTaxonomy + + + + + Export-PnPTaxonomy + + TermSetId + + If specified, will export the specified termset only + + GuidPipeBind + + + TermStoreName + + Term store to export; if not specified the default term store is used. + + String + + + IncludeID + + If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid> + + SwitchParameter + + + Path + + File to export the data to. + + String + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + Delimiter + + The path delimiter to be used, by default this is '|' + + String + + + Encoding + + Defaults to Unicode + + Encoding + + + 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. + + SPOnlineConnection + + + + + + Delimiter + + The path delimiter to be used, by default this is '|' + + String + + String + + + + + Encoding + + Defaults to Unicode + + Encoding + + Encoding + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + IncludeID + + If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid> + + SwitchParameter + + SwitchParameter + + + + + Path + + File to export the data to. + + String + + String + + + + + TermSetId + + If specified, will export the specified termset only + + GuidPipeBind + + GuidPipeBind + + + + + TermStoreName + + Term store to export; if not specified the default term store is used. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Export-PnPTaxonomy + + Exports the full taxonomy to the standard output + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Export-PnPTaxonomy -Path c:\output.txt + + Exports the full taxonomy the file output.txt + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Export-PnPTaxonomy -Path c:\output.txt -TermSet f6f43025-7242-4f7a-b739-41fa32847254 + + Exports the term set with the specified id + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Export-PnPTermGroupToXml + + Exports a taxonomy TermGroup to either the output or to an XML file. + + + + + Export + PnPTermGroupToXml + + + + + Export-PnPTermGroupToXml + + Identity + + The ID or name of the termgroup + + Id, Title or TermGroup + + + Out + + File to export the data to. + + String + + + FullTemplate + + If specified, a full provisioning template structure will be returned + + SwitchParameter + + + Encoding + + Defaults to Unicode + + Encoding + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Encoding + + Defaults to Unicode + + Encoding + + Encoding + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + FullTemplate + + If specified, a full provisioning template structure will be returned + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID or name of the termgroup + + Id, Title or TermGroup + + Id, Title or TermGroup + + + + + Out + + File to export the data to. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Export-PnPTermGroupToXml + + Exports all term groups in the default site collection term store to the standard output + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Export-PnPTermGroupToXml -Out output.xml + + Exports all term groups in the default site collection term store to the file 'output.xml' in the current folder + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Export-PnPTermGroupToXml -Out c:\output.xml -Identity "Test Group" + + Exports the term group with the specified name to the file 'output.xml' located in the root folder of the C: drive. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> $termgroup = Get-PnPTermGroup -GroupName Test +PS:> $termgroup | Export-PnPTermGroupToXml -Out c:\output.xml + + Retrieves a termgroup and subsequently exports that term group to a the file named 'output.xml' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Find-PnPFile + + Finds a file in the virtual file system of the web. + + + + + Find + PnPFile + + + + + Find-PnPFile + + Match + + Wildcard query + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Find-PnPFile + + List + + List title, url or an actual List object to query + + ListPipeBind + + + Match + + Wildcard query + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Find-PnPFile + + Folder + + Folder object or relative url of a folder to query + + FolderPipeBind + + + Match + + Wildcard query + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + Folder object or relative url of a folder to query + + FolderPipeBind + + FolderPipeBind + + + + + List + + List title, url or an actual List object to query + + ListPipeBind + + ListPipeBind + + + + + Match + + Wildcard query + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.File + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Find-PnPFile -Match *.master + + Will return all masterpages located in the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Find-PnPFile -List "Documents" -Match *.pdf + + Will return all pdf files located in given list. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Find-PnPFile -Folder "Shared Documents/Sub Folder" -Match *.docx + + Will return all docx files located in given folder. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPApp + + * Supported in: SharePoint Online. + +Returns the available apps from the app catalog + + + + + Get + PnPApp + + + + + Get-PnPApp + + Identity + + Specifies the Id of an app which is available in the app catalog + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of an app which is available in the app catalog + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + List<OfficeDevPnP.Core.ALM.AppMetadata> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPApp + + This will return all available app metadata from the tenant app catalog. It will list the installed version in the current site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f + + This will the specific app metadata from the app catalog. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAppInstance + + Returns a SharePoint AddIn Instance + + + + + Get + PnPAppInstance + + + + Returns a SharePoint App/Addin that has been installed in the current site + + + + Get-PnPAppInstance + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + Specifies the Id of the App Instance + + AppPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of the App Instance + + AppPipeBind + + AppPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + List<Microsoft.SharePoint.Client.AppInstance> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAppInstance + + This will return all addin instances in the site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will return an addin instance with the specified id. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAuditing + + Get the Auditing setting of a site + + + + + Get + PnPAuditing + + + + + Get-PnPAuditing + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Audit + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAuditing + + Gets the auditing settings of the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAuthenticationRealm + + Returns the authentication realm + + + + + Get + PnPAuthenticationRealm + + + + Gets the authentication realm for the current web + + + + Get-PnPAuthenticationRealm + + Url + + Specifies the URL of the site + + String + + + 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. + + SPOnlineConnection + + + + + + Url + + Specifies the URL of the site + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAuthenticationRealm + + This will get the authentication realm for the current connected site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAuthenticationRealm -Url https://contoso.sharepoint.com + + This will get the authentication realm for https://contoso.sharepoint.com + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAvailableClientSideComponents + + * Supported in: SharePoint Online. + +Gets the available client side components on a particular page + + + + + Get + PnPAvailableClientSideComponents + + + + + Get-PnPAvailableClientSideComponents + + Page + + The name of the page. + + ClientSidePagePipeBind + + + Component + + Specifies the component instance or Id to look for. + + ClientSideComponentPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Component + + Specifies the component instance or Id to look for. + + ClientSideComponentPipeBind + + ClientSideComponentPipeBind + + + + + Page + + The name of the page. + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" + + Gets the list of available client side components on the page 'MyPage.aspx' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAvailableClientSideComponents $page + + Gets the list of available client side components on the page contained in the $page variable + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" -ComponentName "HelloWorld" + + Gets the client side component 'HelloWorld' if available on the page 'MyPage.aspx' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAzureADManifestKeyCredentials + + Return the JSON Manifest snippet for Azure Apps + + + + + Get + PnPAzureADManifestKeyCredentials + + + + Creates the JSON snippet that is required for the manifest JSON file for Azure WebApplication / WebAPI apps + + + + Get-PnPAzureADManifestKeyCredentials + + CertPath + + Specifies the path to the certificate like .\mycert.cer + + String + + + + + + CertPath + + Specifies the path to the certificate like .\mycert.cer + + String + + String + + + + + + + + System.String + + + Outputs a JSON formatted string + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer + + Output the JSON snippet which needs to be replaced in the application manifest file + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer | Set-Clipboard + + Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPClientSideComponent + + * Supported in: SharePoint Online. + +Retrieve one or more Client-Side components from a page + + + + + Get + PnPClientSideComponent + + + + + Get-PnPClientSideComponent + + Page + + The name of the page + + ClientSidePagePipeBind + + + InstanceId + + The instance id of the component + + GuidPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + InstanceId + + The instance id of the component + + GuidPipeBind + + GuidPipeBind + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPClientSideComponent -Page Home + + Returns all controls defined on the given page. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPClientSideComponent -Page Home -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 + + Returns a specific control defined on the given page. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPClientSidePage + + * Supported in: SharePoint Online. + +Gets a Client-Side Page + + + + + Get + PnPClientSidePage + + + + + Get-PnPClientSidePage + + Identity + + The name of the page + + ClientSidePagePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPClientSidePage -Identity "MyPage.aspx" + + Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPClientSidePage "MyPage" + + Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPContentType + + Retrieves a content type + + + + + Get + PnPContentType + + + + + Get-PnPContentType + + List + + List to query + + ListPipeBind + + + InSiteHierarchy + + Search site hierarchy for content types + + SwitchParameter + + + Identity + + Name or ID of the content type to retrieve + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Name or ID of the content type to retrieve + + ContentTypePipeBind + + ContentTypePipeBind + + + + + InSiteHierarchy + + Search site hierarchy for content types + + SwitchParameter + + SwitchParameter + + + + + List + + List to query + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.ContentType + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPContentType + + This will get a listing of all available content types within the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPContentType -InSiteHierarchy + + This will get a listing of all available content types within the site collection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPContentType -Identity "Project Document" + + This will get the content type with the name "Project Document" within the current context + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPContentType -List "Documents" + + This will get a listing of all available content types within the list "Documents" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPContentTypePublishingHubUrl + + Returns the url to Content Type Publishing Hub + + + + + Get + PnPContentTypePublishingHubUrl + + + + + Get-PnPContentTypePublishingHubUrl + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $url = Get-PnPContentTypePublishingHubUrl +PS:> Connect-PnPOnline -Url $url +PS:> Get-PnPContentType + + + This will retrieve the url to the content type hub, connect to it, and then retrieve the content types form that site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPCustomAction + + Return user custom actions + + + + + Get + PnPCustomAction + + + + Returns all or a specific user custom action + + + + Get-PnPCustomAction + + Identity + + Identity of the CustomAction to return. Omit to return all CustomActions. + + GuidPipeBind + + + Scope + + Scope of the CustomAction, either Web, Site or All to return both + + CustomActionScope + + + ThrowExceptionIfCustomActionNotFound + + Switch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + Identity of the CustomAction to return. Omit to return all CustomActions. + + GuidPipeBind + + GuidPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Scope + + Scope of the CustomAction, either Web, Site or All to return both + + CustomActionScope + + CustomActionScope + + + + + ThrowExceptionIfCustomActionNotFound + + Switch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist + + SwitchParameter + + SwitchParameter + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + List<Microsoft.SharePoint.Client.UserCustomAction> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPCustomAction + + Returns all custom actions of the current site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 + + Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPCustomAction -Scope web + + Returns all custom actions for the current web object. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPDefaultColumnValues + + Gets the default column values for all folders in document library + + + + + Get + PnPDefaultColumnValues + + + + Gets the default column values for a document library, per folder. Supports both text, people and taxonomy fields. + + + + Get-PnPDefaultColumnValues + + List + + The ID, Name or Url of the list. + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + The ID, Name or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPDocumentSetTemplate + + Retrieves a document set template + + + + + Get + PnPDocumentSetTemplate + + + + + Get-PnPDocumentSetTemplate + + Identity + + Either specify a name, an id, a document set template object or a content type object + + DocumentSetPipeBind + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + Either specify a name, an id, a document set template object or a content type object + + DocumentSetPipeBind + + DocumentSetPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.DocumentSet.DocumentSetTemplate + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPDocumentSetTemplate -Identity "Test Document Set" + + This will get the document set template with the name "Test Document Set" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPDocumentSetTemplate -Identity "0x0120D520005DB65D094035A241BAC9AF083F825F3B" + + This will get the document set template with the id "0x0120D520005DB65D094035A241BAC9AF083F825F3B" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPEventReceiver + + Return registered eventreceivers + + + + + Get + PnPEventReceiver + + + + Returns all registered or a specific eventreceiver + + + + Get-PnPEventReceiver + + List + + The list object from which to get the event receiver object + + ListPipeBind + + + Identity + + The Guid of the event receiver + + EventReceiverPipeBind + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPEventReceiver + + Identity + + The Guid of the event receiver + + EventReceiverPipeBind + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Guid of the event receiver + + EventReceiverPipeBind + + EventReceiverPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + List + + The list object from which to get the event receiver object + + ListPipeBind + + ListPipeBind + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.EventReceiverDefinition + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPEventReceiver + + This will return all registered event receivers on the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 + + This will return the event receiver with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPEventReceiver -Identity MyReceiver + + This will return the event receiver with the provided ReceiverName "MyReceiver" from the current web + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPEventReceiver -List "ProjectList" + + This will return all registered event receivers in the provided "ProjectList" list + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 + + This will return the event receiver in the provided "ProjectList" list with with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver + + This will return the event receiver in the "ProjectList" list with the provided ReceiverName "MyReceiver" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPFeature + + Returns all activated or a specific activated feature + + + + + Get + PnPFeature + + + + + Get-PnPFeature + + Scope + + The scope of the feature. Defaults to Web. + + FeatureScope + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + The feature ID or name to query for, Querying by name is not supported in version 15 of the Client Side Object Model + + FeaturePipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The feature ID or name to query for, Querying by name is not supported in version 15 of the Client Side Object Model + + FeaturePipeBind + + FeaturePipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Scope + + The scope of the feature. Defaults to Web. + + FeatureScope + + FeatureScope + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + List<Microsoft.SharePoint.Client.Feature> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPFeature + + This will return all activated web scoped features + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPFeature -Scope Site + + This will return all activated site scoped features + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 + + This will return a specific activated web scoped feature + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -Scope Site + + This will return a specific activated site scoped feature + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPField + + Returns a field from a list or site + + + + + Get + PnPField + + + + + Get-PnPField + + List + + The list object or name where to get the field from + + ListPipeBind + + + Group + + Filter to the specified group + + String + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + The field object or name to get + + FieldPipeBind + + + 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. + + SPOnlineConnection + + + + + + Group + + Filter to the specified group + + String + + String + + + + + Identity + + The field object or name to get + + FieldPipeBind + + FieldPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + List + + The list object or name where to get the field from + + ListPipeBind + + ListPipeBind + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPField + + Gets all the fields from the current site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPField -List "Demo list" -Identity "Speakers" + + Gets the speakers field from the list Demo list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPFile + + Downloads a file. + + + + + Get + PnPFile + + + + + Get-PnPFile + + Url + + The URL (server or site relative) to the file + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPFile + + Url + + The URL (server or site relative) to the file + + String + + + AsListItem + + Returns the file as a listitem showing all its properties + + SwitchParameter + + + ThrowExceptionIfFileNotFound + + If provided in combination with -AsListItem, a Sytem.ArgumentException will be thrown if the file specified in the -Url argument does not exist. Otherwise it will return nothing instead. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPFile + + Url + + The URL (server or site relative) to the file + + String + + + AsString + + Retrieve the file contents as a string + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPFile + + AsFile + + + + SwitchParameter + + + Url + + The URL (server or site relative) to the file + + String + + + Path + + Local path where the file should be saved + + String + + + Filename + + Name for the local file + + String + + + Force + + Overwrites the file if it exists. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AsFile + + + + SwitchParameter + + SwitchParameter + + + + + AsListItem + + Returns the file as a listitem showing all its properties + + SwitchParameter + + SwitchParameter + + + + + AsString + + Retrieve the file contents as a string + + SwitchParameter + + SwitchParameter + + + + + Filename + + Name for the local file + + String + + String + + + + + Force + + Overwrites the file if it exists. + + SwitchParameter + + SwitchParameter + + + + + Path + + Local path where the file should be saved + + String + + String + + + + + ThrowExceptionIfFileNotFound + + If provided in combination with -AsListItem, a Sytem.ArgumentException will be thrown if the file specified in the -Url argument does not exist. Otherwise it will return nothing instead. + + SwitchParameter + + SwitchParameter + + + + + Url + + The URL (server or site relative) to the file + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.File + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor + + Retrieves the file and downloads it to the current folder + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile + + Retrieves the file and downloads it to c:\temp\company.spcolor + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsString + + Retrieves the file and outputs its contents to the console + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsFile + + Retrieves the file and returns it as a File object + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsListItem + + Retrieves the file and returns it as a ListItem object + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPFile -Url _catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile + + Retrieves the file by site relative URL and downloads it to c:\temp\company.spcolor + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPFolder + + Return a folder object + + + + + Get + PnPFolder + + + + Retrieves a folder if it exists. Use Ensure-PnPFolder to create the folder if it does not exist. + + + + Get-PnPFolder + + Url + + Site or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web. + + String + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Url + + Site or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web. + + String + + String + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Folder + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPFolder -Url "Shared Documents" + + Returns the folder called 'Shared Documents' which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPFolder -Url "/sites/demo/Shared Documents" + + Returns the folder called 'Shared Documents' which is located in the root of the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Ensure-PnPFolder: + https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/EnsureSPOFolder.md + + + + + + Get-PnPFolderItem + + List content in folder + + + + + Get + PnPFolderItem + + + + + Get-PnPFolderItem + + ItemType + + The type of contents to retrieve, either File, Folder or All (default) + + String + + + ItemName + + Optional name of the item to retrieve + + String + + + FolderSiteRelativeUrl + + The site relative folder to retrieve + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + FolderSiteRelativeUrl + + The site relative folder to retrieve + + String + + String + + + + + ItemName + + Optional name of the item to retrieve + + String + + String + + + + + ItemType + + The type of contents to retrieve, either File, Folder or All (default) + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" + + Returns the contents of the folder SitePages which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx" + + Returns the file 'Default.aspx' which is located in the folder SitePages which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType Folder + + Returns all folders in the folder SitePages which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType File + + Returns all files in the folder SitePages which is located in the root of the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPGroup + + Returns a specific group or all groups. + + + + + Get + PnPGroup + + + + + Get-PnPGroup + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Identity + + Get a specific group by name + + GroupPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPGroup + + AssociatedMemberGroup + + Retrieve the associated member group + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPGroup + + AssociatedVisitorGroup + + Retrieve the associated visitor group + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPGroup + + AssociatedOwnerGroup + + Retrieve the associated owner group + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPGroup + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + AssociatedMemberGroup + + Retrieve the associated member group + + SwitchParameter + + SwitchParameter + + + + + AssociatedOwnerGroup + + Retrieve the associated owner group + + SwitchParameter + + SwitchParameter + + + + + AssociatedVisitorGroup + + Retrieve the associated visitor group + + SwitchParameter + + SwitchParameter + + + + + Identity + + Get a specific group by name + + GroupPipeBind + + GroupPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + List<Microsoft.SharePoint.Client.Group> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPGroup + + Returns all groups + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPGroup -Identity 'My Site Users' + + This will return the group called 'My Site Users' if available + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPGroup -AssociatedMemberGroup + + This will return the current members group for the site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPGroupMembers + + Retrieves all members of a group + + + + + Get + PnPGroupMembers + + + + This command will return all the users that are a member of the provided SharePoint Group + + + + Get-PnPGroupMembers + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + GroupPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.User + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPGroupMembers -Identity 'Marketing Site Members' + + Returns all the users that are a member of the group 'Marketing Site Members' in the current sitecollection + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPGroup | Get-PnPGroupMembers + + Returns all the users that are a member of any of the groups in the current sitecollection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMembers + + Returns all the users that are a member of any of the groups of which their name starts with the word 'Marketing' in the current sitecollection + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPGroupPermissions + + Returns the permissions for a specific SharePoint group + + + + + Get + PnPGroupPermissions + + + + + Get-PnPGroupPermissions + + Identity + + Get the permissions of a specific group by name + + GroupPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Get the permissions of a specific group by name + + GroupPipeBind + + GroupPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.RoleDefinitionBindingCollection + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPGroupPermissions -Identity 'My Site Members' + + Returns the permissions for the SharePoint group with the name 'My Site Members' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPHealthScore + + Retrieves the healthscore + + + + + Get + PnPHealthScore + + + + Retrieves the current health score value of the server which is a value between 0 and 10. Lower is better. + + + + + + + System.Int32 + + + Returns a int value representing the current health score value of the server. + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPHealthScore + + This will retrieve the current health score of the server. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPHealthScore -Url https://contoso.sharepoint.com + + This will retrieve the current health score for the url https://contoso.sharepoint.com. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPHideDefaultThemes + + * Supported in: SharePoint Online. + +Returns if the default / OOTB themes should be visible to users or not. + + + + + Get + PnPHideDefaultThemes + + + + Returns if the default themes are visible. Use Set-PnPHideDefaultThemes to change this value. + +You must be a SharePoint Online global administrator to run the cmdlet. + + + + Get-PnPHideDefaultThemes + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPHideDefaultThemes + + This example returns the current setting if the default themes should be visible + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPHomePage + + Return the homepage + + + + + Get + PnPHomePage + + + + Returns the URL to the page set as home page + + + + Get-PnPHomePage + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPHomePage + + Will return the URL of the home page of the web. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPHubSite + + * Supported in: SharePoint Online. + +Retrieve all or a specific hubsite. + + + + + Get + PnPHubSite + + + + + Get-PnPHubSite + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPStorageEntity + + Returns all site storage entities/farm properties + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantSite -Key MyKey + + Returns the storage entity/farm property with the given key. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPHubSiteNavigation + + * Supported in: SharePoint Online. + +Retrieve all or a specific hubsite. + + + + + Get + PnPHubSiteNavigation + + + + + Get-PnPHubSiteNavigation + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPStorageEntity + + Returns all site storage entities/farm properties + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantSite -Key MyKey + + Returns the storage entity/farm property with the given key. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPIndexedPropertyKeys + + Returns the keys of the property bag values that have been marked for indexing by search + + + + + Get + PnPIndexedPropertyKeys + + + + + Get-PnPIndexedPropertyKeys + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPInPlaceRecordsManagement + + Returns if the place records management feature is enabled. + + + + + Get + PnPInPlaceRecordsManagement + + + + + Get-PnPInPlaceRecordsManagement + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPInPlaceRecordsManagement + + Returns if $true if in place records management is active + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPJavaScriptLink + + Returns all or a specific custom action(s) with location type ScriptLink + + + + + Get + PnPJavaScriptLink + + + + + Get-PnPJavaScriptLink + + Scope + + Scope of the action, either Web, Site or All to return both, defaults to Web + + CustomActionScope + + + ThrowExceptionIfJavaScriptLinkNotFound + + Switch parameter if an exception should be thrown if the requested JavaScriptLink does not exist (true) or if omitted, nothing will be returned in case the JavaScriptLink does not exist + + SwitchParameter + + + Name + + Name of the Javascript link. Omit this parameter to retrieve all script links + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Name + + Name of the Javascript link. Omit this parameter to retrieve all script links + + String + + String + + + + + Scope + + Scope of the action, either Web, Site or All to return both, defaults to Web + + CustomActionScope + + CustomActionScope + + + + + ThrowExceptionIfJavaScriptLinkNotFound + + Switch parameter if an exception should be thrown if the requested JavaScriptLink does not exist (true) or if omitted, nothing will be returned in case the JavaScriptLink does not exist + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.UserCustomAction + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPJavaScriptLink + + Returns all web scoped JavaScript links + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPJavaScriptLink -Scope All + + Returns all web and site scoped JavaScript links + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPJavaScriptLink -Scope Web + + Returns all Web scoped JavaScript links + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPJavaScriptLink -Scope Site + + Returns all Site scoped JavaScript links + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPJavaScriptLink -Name Test + + Returns the web scoped JavaScript link named Test + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPList + + Returns a List object + + + + + Get + PnPList + + + + + Get-PnPList + + ThrowExceptionIfListNotFound + + Switch parameter if an exception should be thrown if the requested list does not exist (true) or if omitted, nothing will be returned in case the list does not exist + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + The ID, name or Url (Lists/MyList) of the list. + + ListPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID, name or Url (Lists/MyList) of the list. + + ListPipeBind + + ListPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + ThrowExceptionIfListNotFound + + Switch parameter if an exception should be thrown if the requested list does not exist (true) or if omitted, nothing will be returned in case the list does not exist + + SwitchParameter + + SwitchParameter + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.List + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPList + + Returns all lists in the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPList -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + Returns a list with the given id. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPList -Identity Lists/Announcements + + Returns a list with the given url. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPListInformationRightsManagement + + Get the site closure status of the site which has a site policy applied + + + + + Get + PnPListInformationRightsManagement + + + + + Get-PnPListInformationRightsManagement + + List + + + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPListInformationRightsManagement -List "Documents" + + Returns Information Rights Management (IRM) settings for the list. See 'Get-Help Set-PnPListInformationRightsManagement -Detailed' for more information about the various values. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPListItem + + Retrieves list items + + + + + Get + PnPListItem + + + + + Get-PnPListItem + + List + + The list to query + + ListPipeBind + + + Id + + The ID of the item to retrieve + + Int32 + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPListItem + + List + + The list to query + + ListPipeBind + + + UniqueId + + The unique id (GUID) of the item to retrieve + + GuidPipeBind + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPListItem + + List + + The list to query + + ListPipeBind + + + Query + + The CAML query to execute against the list + + String + + + PageSize + + The number of items to retrieve per page request. + + Int32 + + + ScriptBlock + + The script block to run after every page request. + + ScriptBlock + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPListItem + + List + + The list to query + + ListPipeBind + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + + PageSize + + The number of items to retrieve per page request. + + Int32 + + + ScriptBlock + + The script block to run after every page request. + + ScriptBlock + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Fields + + The fields to retrieve. If not specified all fields will be loaded in the returned list object. + + String[] + + String[] + + + + + Id + + The ID of the item to retrieve + + Int32 + + Int32 + + + + + List + + The list to query + + ListPipeBind + + ListPipeBind + + + + + PageSize + + The number of items to retrieve per page request. + + Int32 + + Int32 + + + + + Query + + The CAML query to execute against the list + + String + + String + + + + + ScriptBlock + + The script block to run after every page request. + + ScriptBlock + + ScriptBlock + + + + + UniqueId + + The unique id (GUID) of the item to retrieve + + GuidPipeBind + + GuidPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.ListItem + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPListItem -List Tasks + + Retrieves all list items from the Tasks list + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPListItem -List Tasks -Id 1 + + Retrieves the list item with ID 1 from from the Tasks list + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 + + Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> (Get-PnPListItem -List Tasks -Fields "Title","GUID").FieldValues + + Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>" + + Retrieves all list items based on the CAML query specified + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPListItem -List Tasks -PageSize 1000 + + Retrieves all list items from the Tasks list in pages of 1000 items + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | % { $_.BreakRoleInheritance($true, $true) } + + Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPListRecordDeclaration + + * Supported in: SharePoint Online. + +Returns the manual record declaration settings for a list + + + + + Get + PnPListRecordDeclaration + + + + + Get-PnPListRecordDeclaration + + List + + The list to retrieve the record declaration settings for + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + The list to retrieve the record declaration settings for + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPListRecordDeclaration -List "Documents" + + Returns the record declaration setting for the list "Documents" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPMasterPage + + Returns the URLs of the default Master Page and the custom Master Page. + + + + + Get + PnPMasterPage + + + + + Get-PnPMasterPage + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPNavigationNode + + Returns all or a specific navigation node + + + + + Get + PnPNavigationNode + + + + + Get-PnPNavigationNode + + Location + + The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch + + NavigationType + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPNavigationNode + + Id + + The Id of the node to retrieve + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Id + + The Id of the node to retrieve + + Int32 + + Int32 + + + + + Location + + The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch + + NavigationType + + NavigationType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPNavigationNode + + Returns all navigation nodes in the quicklaunch navigation + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPNavigationNode -QuickLaunch + + Returns all navigation nodes in the quicklaunch navigation + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPNavigationNode -TopNavigationBar + + Returns all navigation nodes in the top navigation bar + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> $node = Get-PnPNavigationNode -Id 2030 +PS> $children = $node.Children + + Returns the selected navigation node and retrieves any children + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAccessToken + + Returns the current OAuth Access token + + + + + Get + PnPAccessToken + + + + Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API + + + + Get-PnPAccessToken + + Decoded + + Returns the access token in a decoded manner + + SwitchParameter + + + + + + Decoded + + Returns the access token in a decoded manner + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAccessToken + + Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAzureCertificate + + Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. + +See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. + +KeyCredentials contains the ADAL app manifest sections. + +Certificate contains the PEM encoded certificate. + +PrivateKey contains the PEM encoded private key of the certificate. + + + + + Get + PnPAzureCertificate + + + + + Get-PnPAzureCertificate + + CertificatePath + + Path to the certificate (*.pfx) + + String + + + CertificatePassword + + Password to the certificate (*.pfx) + + SecureString + + + + + + CertificatePassword + + Password to the certificate (*.pfx) + + SecureString + + SecureString + + + + + CertificatePath + + Path to the certificate (*.pfx) + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPAzureCertificate -CertificatePath "mycert.pfx" + + This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAzureCertificate -CertificatePath "mycert.pfx" -CertificatePassword (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) + + This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx which has the password YourPassword. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPAzureCertificate -CertificatePath "mycert.cer" | clip + + Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPAppAuthAccessToken + + Returns the access token + + + + + Get + PnPAppAuthAccessToken + + + + Returns the access token from the current client context (only works with App-Only authentication) + + + + Get-PnPAppAuthAccessToken + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $accessToken = Get-PnPAppAuthAccessToken + + This will put the access token from current context in the $accessToken variable. Will only work in App authentication flow (App+user or App-Only) + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPConnection + + Returns the current context + + + + + Get + PnPConnection + + + + Returns a PnP PowerShell Connection for use with the -Connection parameter on other cmdlets. + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $ctx = Get-PnPConnection + + This will put the current connection for use with the -Connection parameter on other cmdlets. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteCollectionTermStore + + Returns the site collection term store + + + + + Get + PnPSiteCollectionTermStore + + + + + Get-PnPSiteCollectionTermStore + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TermStore + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteCollectionTermStore + + Returns the site collection term store. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPStorageEntity + + * Supported in: SharePoint Online. + +Retrieve Storage Entities / Farm Properties. + + + + + Get + PnPStorageEntity + + + + + Get-PnPStorageEntity + + Key + + The key of the value to retrieve. + + String + + + 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. + + SPOnlineConnection + + + + + + Key + + The key of the value to retrieve. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPStorageEntity + + Returns all site storage entities/farm properties + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPStorageEntity -Key MyKey + + Returns the storage entity/farm property with the given key. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPPropertyBag + + Returns the property bag values. + + + + + Get + PnPPropertyBag + + + + + Get-PnPPropertyBag + + Folder + + Site relative url of the folder. See examples for use. + + String + + + Key + + Key that should be looked up + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + Site relative url of the folder. See examples for use. + + String + + String + + + + + Key + + Key that should be looked up + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + SharePointPnP.PowerShell.Commands.PropertyBagValue + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPPropertyBag + + This will return all web property bag values + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPPropertyBag -Key MyKey + + This will return the value of the key MyKey from the web property bag + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPPropertyBag -Folder /MyFolder + + This will return all property bag values for the folder MyFolder which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPPropertyBag -Folder /MyFolder -Key vti_mykey + + This will return the value of the key vti_mykey from the folder MyFolder which is located in the root of the current web + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPPropertyBag -Folder / -Key vti_mykey + + This will return the value of the key vti_mykey from the root folder of the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPProvisioningTemplate + + Generates a provisioning template from a web + + + + + Get + PnPProvisioningTemplate + + + + + Get-PnPProvisioningTemplate + + IncludeAllTermGroups + + If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup. + + SwitchParameter + + + IncludeSiteCollectionTermGroup + + If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups. + + SwitchParameter + + + IncludeSiteGroups + + If specified all site groups will be included. + + SwitchParameter + + + IncludeTermGroupsSecurity + + If specified all the managers and contributors of term groups will be included. + + SwitchParameter + + + IncludeSearchConfiguration + + If specified the template will contain the current search configuration of the site. + + SwitchParameter + + + PersistBrandingFiles + + If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved. + + SwitchParameter + + + PersistPublishingFiles + + If specified the files used for the publishing feature will be saved. + + SwitchParameter + + + IncludeNativePublishingFiles + + If specified, out of the box / native publishing files will be saved. + + SwitchParameter + + + SkipVersionCheck + + During extraction the version of the server will be checked for certain actions. If you specify this switch, this check will be skipped. + + SwitchParameter + + + PersistMultiLanguageResources + + If specified, resource values for applicable artifacts will be persisted to a resource file + + SwitchParameter + + + ResourceFilePrefix + + 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. + + String + + + Handlers + + Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting. + + Handlers + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while extracting a template. + + ExtensibilityHandler[] + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while extracting a template. + + ITemplateProviderExtension[] + + + ContentTypeGroups + + Allows you to specify from which content type group(s) the content types should be included into the template. + + String[] + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + + TemplateDisplayName + + It can be used to specify the DisplayName of the template file that will be extracted. + + String + + + TemplateImagePreviewUrl + + It can be used to specify the ImagePreviewUrl of the template file that will be extracted. + + String + + + TemplateProperties + + It can be used to specify custom Properties for the template file that will be extracted. + + Hashtable + + + OutputInstance + + Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter. + + SwitchParameter + + + ExcludeContentTypesFromSyndication + + Specify whether or not content types issued from a content hub should be exported. By default, these content types are included. + + SwitchParameter + + + Out + + Filename to write to, optionally including full path + + String + + + Schema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentTypeGroups + + Allows you to specify from which content type group(s) the content types should be included into the template. + + String[] + + String[] + + + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + Encoding + + + + + ExcludeContentTypesFromSyndication + + Specify whether or not content types issued from a content hub should be exported. By default, these content types are included. + + SwitchParameter + + SwitchParameter + + + + + ExcludeHandlers + + Allows you to run all handlers, excluding the ones specified. + + Handlers + + Handlers + + + + + ExtensibilityHandlers + + Allows you to specify ExtensbilityHandlers to execute while extracting a template. + + ExtensibilityHandler[] + + ExtensibilityHandler[] + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + Handlers + + Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting. + + Handlers + + Handlers + + + + + IncludeAllTermGroups + + If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup. + + SwitchParameter + + SwitchParameter + + + + + IncludeNativePublishingFiles + + If specified, out of the box / native publishing files will be saved. + + SwitchParameter + + SwitchParameter + + + + + IncludeSearchConfiguration + + If specified the template will contain the current search configuration of the site. + + SwitchParameter + + SwitchParameter + + + + + IncludeSiteCollectionTermGroup + + If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups. + + SwitchParameter + + SwitchParameter + + + + + IncludeSiteGroups + + If specified all site groups will be included. + + SwitchParameter + + SwitchParameter + + + + + IncludeTermGroupsSecurity + + If specified all the managers and contributors of term groups will be included. + + SwitchParameter + + SwitchParameter + + + + + Out + + Filename to write to, optionally including full path + + String + + String + + + + + OutputInstance + + Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter. + + SwitchParameter + + SwitchParameter + + + + + PersistBrandingFiles + + If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved. + + SwitchParameter + + SwitchParameter + + + + + PersistMultiLanguageResources + + If specified, resource values for applicable artifacts will be persisted to a resource file + + SwitchParameter + + SwitchParameter + + + + + PersistPublishingFiles + + If specified the files used for the publishing feature will be saved. + + SwitchParameter + + SwitchParameter + + + + + ResourceFilePrefix + + 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. + + String + + String + + + + + Schema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + XMLPnPSchemaVersion + + + + + SkipVersionCheck + + During extraction the version of the server will be checked for certain actions. If you specify this switch, this check will be skipped. + + SwitchParameter + + SwitchParameter + + + + + TemplateDisplayName + + It can be used to specify the DisplayName of the template file that will be extracted. + + String + + String + + + + + TemplateImagePreviewUrl + + It can be used to specify the ImagePreviewUrl of the template file that will be extracted. + + String + + String + + + + + TemplateProperties + + It can be used to specify custom Properties for the template file that will be extracted. + + Hashtable + + Hashtable + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while extracting a template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp + + Extracts a provisioning template in Office Open XML from the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.xml + + Extracts a provisioning template in XML format from the current web. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -Schema V201503 + + Extracts a provisioning template in Office Open XML from the current web and saves it in the V201503 version of the schema. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -IncludeAllTermGroups + + Extracts a provisioning template in Office Open XML from the current web and includes all term groups, term sets and terms from the Managed Metadata Service Taxonomy. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -IncludeSiteCollectionTermGroup + + Extracts a provisioning template in Office Open XML from the current web and includes the term group currently (if set) assigned to the site collection. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistComposedLookFiles + + Extracts a provisioning template in Office Open XML from the current web and saves the files that make up the composed look to the same folder as where the template is saved. + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -Handlers Lists, SiteSecurity + + Extracts a provisioning template in Office Open XML from the current web, but only processes lists and site security when generating the template. + + + + + + + + + + ------------------EXAMPLE 8--------------------- + + + + +PS:> $handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 +PS:> $handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 +PS:> Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2 + + This will create two new ExtensibilityHandler objects that are run during extraction of the template + + + + + + + + + + ------------------EXAMPLE 9--------------------- + + Only supported on SP2016 and SP Online + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources + + Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named after the value specified in the Out parameter. For instance if the Out parameter is specified as -Out 'template.xml' the generated resource file will be called 'template.en-US.resx'. + + + + + + + + + + ------------------EXAMPLE 10--------------------- + + Only supported on SP2016 and SP Online + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources -ResourceFilePrefix MyResources + + Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named 'MyResources.en-US.resx' etc. + + + + + + + + + + ------------------EXAMPLE 11--------------------- + + + + PS:> $template = Get-PnPProvisioningTemplate -OutputInstance + + Extracts an instance of a provisioning template object from the current web. This syntax cannot be used together with the -Out parameter, but it can be used together with any other supported parameters. + + + + + + + + + + ------------------EXAMPLE 12--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -ContentTypeGroups "Group A","Group B" + + Extracts a provisioning template in Office Open XML from the current web, but only processes content types from the to given content type groups. + + + + + + + + + + ------------------EXAMPLE 13--------------------- + + + + PS:> Get-PnPProvisioningTemplate -Out template.pnp -ExcludeContentTypesFromSyndication + + Extracts a provisioning template in Office Open XML from the current web, excluding content types provisioned through content type syndication (content type hub), in order to prevent provisioning errors if the target also provision the content type using syndication. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Encoding: + https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx + + + + + + Get-PnPProvisioningTemplateFromGallery + + Retrieves or searches provisioning templates from the PnP Template Gallery + + + + + Get + PnPProvisioningTemplateFromGallery + + + + + Get-PnPProvisioningTemplateFromGallery + + Identity + + + + Guid + + + Path + + + + String + + + Force + + + + SwitchParameter + + + + Get-PnPProvisioningTemplateFromGallery + + Search + + + + String + + + TargetPlatform + + + + TargetPlatform + + + TargetScope + + + + TargetScope + + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + Identity + + + + Guid + + Guid + + + + + Path + + + + String + + String + + + + + Search + + + + String + + String + + + + + TargetPlatform + + + + TargetPlatform + + TargetPlatform + + + + + TargetScope + + + + TargetScope + + TargetScope + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Get-PnPProvisioningTemplateFromGallery + + Retrieves all templates from the gallery + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Get-PnPProvisioningTemplateFromGallery -Search "Data" + + Searches for a templates containing the word 'Data' in the Display Name + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd + + Retrieves a template with the specified ID + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + $template = Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd +Apply-PnPProvisioningTemplate -InputInstance $template + + Retrieves a template with the specified ID and applies it to the site. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + $template = Get-PnPProvisioningTemplateFromGallery -Identity ae925674-8aa6-438b-acd0-d2699a022edd -Path c:\temp + + Retrieves a template with the specified ID and saves the template to the specified path + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPPublishingImageRendition + + Returns all image renditions or if Identity is specified a specific one + + + + + Get + PnPPublishingImageRendition + + + + + Get-PnPPublishingImageRendition + + Identity + + Id or name of an existing image rendition + + ImageRenditionPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Id or name of an existing image rendition + + ImageRenditionPipeBind + + ImageRenditionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Publishing.ImageRendition + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPPublishingImageRendition + + Returns all Image Renditions + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPPublishingImageRendition -Identity "Test" + + Returns the image rendition named "Test" + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPPublishingImageRendition -Identity 2 + + Returns the image rendition where its id equals 2 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPRecycleBinItem + + Returns the items in the recycle bin from the context + + + + + Get + PnPRecycleBinItem + + + + + Get-PnPRecycleBinItem + + Identity + + Returns a recycle bin item with a specific identity + + GuidPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPRecycleBinItem + + FirstStage + + Return all items in the first stage recycle bin + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Get-PnPRecycleBinItem + + SecondStage + + Return all items in the second stage recycle bin + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Get-PnPRecycleBinItem + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + FirstStage + + Return all items in the first stage recycle bin + + SwitchParameter + + SwitchParameter + + + + + Identity + + Returns a recycle bin item with a specific identity + + GuidPipeBind + + GuidPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + SecondStage + + Return all items in the second stage recycle bin + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.RecycleBinItem + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPRecycleBinItem + + Returns all items in both the first and the second stage recycle bins in the current site collection + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPRecycleBinItem -Identity f3ef6195-9400-4121-9d1c-c997fb5b86c2 + + Returns all a specific recycle bin item by id + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPRecycleBinItem -FirstStage + + Returns all items in only the first stage recycle bin in the current site collection + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPRecycleBinItem -SecondStage + + Returns all items in only the second stage recycle bin in the current site collection + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPRequestAccessEmails + + * Supported in: SharePoint Online. + +Returns the request access e-mail addresses + + + + + Get + PnPRequestAccessEmails + + + + + Get-PnPRequestAccessEmails + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + List<System.String> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPRequestAccessEmails + + This will return all the request access e-mail addresses for the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPRoleDefinition + + Retrieves a Role Definitions of a site + + + + + Get + PnPRoleDefinition + + + + + Get-PnPRoleDefinition + + Identity + + The name of a role definition to retrieve. + + RoleDefinitionPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The name of a role definition to retrieve. + + RoleDefinitionPipeBind + + RoleDefinitionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.RoleDefinition + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPRoleDefinition + + Retrieves the Role Definitions (Permission Levels) settings of the current site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPRoleDefinition -Identity Read + + Retrieves the specified Role Definition (Permission Level) settings of the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSearchConfiguration + + Returns the search configuration + + + + + Get + PnPSearchConfiguration + + + + + Get-PnPSearchConfiguration + + Path + + Local path where the search configuration will be saved + + String + + + Scope + + Scope to use. Either Web, Site, or Subscription. Defaults to Web + + SearchConfigurationScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPSearchConfiguration + + OutputFormat + + Output format for of the configuration. Defaults to complete XML + + OutputFormat + + + Scope + + Scope to use. Either Web, Site, or Subscription. Defaults to Web + + SearchConfigurationScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + OutputFormat + + Output format for of the configuration. Defaults to complete XML + + OutputFormat + + OutputFormat + + + + + Path + + Local path where the search configuration will be saved + + String + + String + + + + + Scope + + Scope to use. Either Web, Site, or Subscription. Defaults to Web + + SearchConfigurationScope + + SearchConfigurationScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.String + + + Does not return a string when the -Path parameter has been specified. + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSearchConfiguration + + Returns the search configuration for the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSearchConfiguration -Scope Site + + Returns the search configuration for the current site collection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSearchConfiguration -Scope Subscription + + Returns the search configuration for the current tenant + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription + + Returns the search configuration for the current tenant and saves it to the specified file + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings + + Returns all custom managed properties and crawled property mapping at the current site collection + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSite + + Returns the current site collection from the context. + + + + + Get + PnPSite + + + + + Get-PnPSite + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Site + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSite + + Gets the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteClassification + + * Supported in: SharePoint Online. + +Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph. + + + + + Get + PnPSiteClassification + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Get-PnPSiteClassification + + Returns the currently set site classifications for the tenant. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteClosure + + Get the site closure status of the site which has a site policy applied + + + + + Get + PnPSiteClosure + + + + + Get-PnPSiteClosure + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteClosure + + Get the site closure status of the site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteCollectionAdmin + + Returns the current site collection administrators of the site colleciton in the current context + + + + + Get + PnPSiteCollectionAdmin + + + + This command will return all current site collection administrators of the site collection in the current context + + + + Get-PnPSiteCollectionAdmin + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteCollectionAdmin + + This will return all the current site collection administrators of the site collection in the current context + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteDesign + + * Supported in: SharePoint Online. + +Retrieve Site Designs that have been registered on the current tenant. + + + + + Get + PnPSiteDesign + + + + + Get-PnPSiteDesign + + Identity + + If specified will retrieve the specified site design + + TenantSiteDesignPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + If specified will retrieve the specified site design + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteDesign + + Returns all registered site designs + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Returns a specific registered site designs + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteDesignRights + + * Supported in: SharePoint Online. + +Returns the principals with design rights on a specific Site Design + + + + + Get + PnPSiteDesignRights + + + + + Get-PnPSiteDesignRights + + Identity + + The ID of the Site Design to receive the rights for + + TenantSiteDesignPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID of the Site Design to receive the rights for + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Returns the principals with rights on a specific site design + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSitePolicy + + Retrieves all or a specific site policy + + + + + Get + PnPSitePolicy + + + + + Get-PnPSitePolicy + + AllAvailable + + Retrieve all available site policies + + SwitchParameter + + + Name + + Retrieves a site policy with a specific name + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AllAvailable + + Retrieve all available site policies + + SwitchParameter + + SwitchParameter + + + + + Name + + Retrieves a site policy with a specific name + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.SitePolicyEntity + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSitePolicy + + Retrieves the current applied site policy. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSitePolicy -AllAvailable + + Retrieves all available site policies. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSitePolicy -Name "Contoso HBI" + + Retrieves an available site policy with the name "Contoso HBI". + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteScript + + * Supported in: SharePoint Online. + +Retrieve Site Scripts that have been registered on the current tenant. + + + + + Get + PnPSiteScript + + + + + Get-PnPSiteScript + + Identity + + If specified will retrieve the specified site script + + TenantSiteScriptPipeBind + + + SiteDesign + + If specified will retrieve the site scripts for this design + + TenantSiteDesignPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + If specified will retrieve the specified site script + + TenantSiteScriptPipeBind + + TenantSiteScriptPipeBind + + + + + SiteDesign + + If specified will retrieve the site scripts for this design + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteScript + + Returns all registered site scripts + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Returns a specific registered site script + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSiteSearchQueryResults + + Executes a search query to retrieve indexed site collections + + + + + Get + PnPSiteSearchQueryResults + + + + + Get-PnPSiteSearchQueryResults + + StartRow + + Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. + + Int32 + + + MaxResults + + Maximum amount of search results to return. Default and max is 500 search results. + + Int32 + + + Query + + Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Get-PnPSiteSearchQueryResults + + All + + Automatically page results until the end to get more than 500 sites. Use with caution! + + SwitchParameter + + + Query + + Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + All + + Automatically page results until the end to get more than 500 sites. Use with caution! + + SwitchParameter + + SwitchParameter + + + + + MaxResults + + Maximum amount of search results to return. Default and max is 500 search results. + + Int32 + + Int32 + + + + + Query + + Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned. + + String + + String + + + + + StartRow + + Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + List<System.Object> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults + + Returns the top 500 site collections indexed by SharePoint Search + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults -Query "WebTemplate:STS" + + Returns the top 500 site collections indexed by SharePoint Search which have are based on the STS (Team Site) template + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults -Query "WebTemplate:SPSPERS" + + Returns the top 500 site collections indexed by SharePoint Search which have are based on the SPSPERS (MySite) template, up to the MaxResult limit + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults -Query "Title:Intranet*" + + Returns the top 500 site collections indexed by SharePoint Search of which the title starts with the word Intranet + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults -MaxResults 10 + + Returns the top 10 site collections indexed by SharePoint Search + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPSiteSearchQueryResults -All + + Returns absolutely all site collections indexed by SharePoint Search + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPContext + + Returns the current context + + + + + Get + PnPContext + + + + Returns a Client Side Object Model context + + + + + + + Microsoft.SharePoint.Client.ClientContext + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $ctx = Get-PnPContext + + This will put the current context in the $ctx variable. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPStoredCredential + + Get a credential + + + + + Get + PnPStoredCredential + + + + Returns a stored credential from the Windows Credential Manager + + + + Get-PnPStoredCredential + + Name + + The credential to retrieve. + + String + + + Type + + The object type of the credential to return from the Credential Manager. Possible valus are 'O365', 'OnPrem' or 'PSCredential' + + CredentialType + + + + + + Name + + The credential to retrieve. + + String + + String + + + + + Type + + The object type of the credential to return from the Credential Manager. Possible valus are 'O365', 'OnPrem' or 'PSCredential' + + CredentialType + + CredentialType + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPStoredCredential -Name O365 + + Returns the credential associated with the specified identifier + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPStoredCredential -Name testEnvironment -Type OnPrem + + Gets the credential associated with the specified identifier from the credential manager and then will return a credential that can be used for on-premises authentication + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPSubWebs + + Returns the subwebs of the current web + + + + + Get + PnPSubWebs + + + + + Get-PnPSubWebs + + Recurse + + If provided, recursion through all subsites and their childs will take place to return them as well + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + If provided, only the subsite with the provided Id, GUID or the Web instance will be returned + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + If provided, only the subsite with the provided Id, GUID or the Web instance will be returned + + WebPipeBind + + WebPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Recurse + + If provided, recursion through all subsites and their childs will take place to return them as well + + SwitchParameter + + SwitchParameter + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Web + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPSubWebs + + Retrieves all subsites of the current context returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSubWebs -Recurse + + Retrieves all subsites of the current context and all of their nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSubWebs -Recurse -Includes "WebTemplate","Description" | Select ServerRelativeUrl, WebTemplate, Description + + Retrieves all subsites of the current context and shows the ServerRelativeUrl, WebTemplate and Description properties in the resulting output + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPSubWebs -Identity Team1 -Recurse + + Retrieves all subsites of the subsite Team1 and all of its nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTaxonomyItem + + Returns a taxonomy item + + + + + Get + PnPTaxonomyItem + + + + + Get-PnPTaxonomyItem + + TermPath + + The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + + 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. + + SPOnlineConnection + + + + + + TermPath + + The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TaxonomyItem + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTaxonomySession + + Returns a taxonomy session + + + + + Get + PnPTaxonomySession + + + + + Get-PnPTaxonomySession + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TaxonomySession + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenant + + * Supported in: SharePoint Online. + +Returns organization-level site collection properties + + + + + Get + PnPTenant + + + + Returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, +ResourceQuotaAllocated, and SiteCreationMode. + +Currently, there are no parameters for this cmdlet. + +You must be a SharePoint Online global administrator to run the cmdlet. + + + + Get-PnPTenant + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenant + + This example returns all tenant settings + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantAppCatalogUrl + + * Supported in: SharePoint Online. + +Retrieves the url of the tenant scoped app catalog. + + + + + Get + PnPTenantAppCatalogUrl + + + + + Get-PnPTenantAppCatalogUrl + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantAppCatalogUrl + + Returns the url of the tenant scoped app catalog site collection + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantCdnEnabled + + * Supported in: SharePoint Online. + +Retrieves if the Office 365 Content Delivery Network has been enabled. + + + + + Get + PnPTenantCdnEnabled + + + + Enables or disabled the public or private Office 365 Content Delivery Network (CDN). + + + + Get-PnPTenantCdnEnabled + + CdnType + + The type of cdn to retrieve the origins from + + SPOTenantCdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The type of cdn to retrieve the origins from + + SPOTenantCdnType + + SPOTenantCdnType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantCdnEnabled -CdnType Public + + Returns the enabled status of the specified CDN + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantCdnOrigin + + * Supported in: SharePoint Online. + +Returns the current registered origins from the public or private content delivery network (CDN). + + + + + Get + PnPTenantCdnOrigin + + + + Returns the current registered origins from the public or private content delivery network (CDN). + + + + Get-PnPTenantCdnOrigin + + CdnType + + The type of cdn to retrieve the origins from + + SPOTenantCdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The type of cdn to retrieve the origins from + + SPOTenantCdnType + + SPOTenantCdnType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantCdnOrigin -CdnType Public + + Returns the configured CDN origins for the specified CDN type + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantCdnPolicies + + * Supported in: SharePoint Online. + +Returns the CDN Policies for the specified CDN (Public | Private). + + + + + Get + PnPTenantCdnPolicies + + + + Enables or disabled the public or private Office 365 Content Delivery Network (CDN). + + + + Get-PnPTenantCdnPolicies + + CdnType + + The type of cdn to retrieve the policies from + + SPOTenantCdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The type of cdn to retrieve the policies from + + SPOTenantCdnType + + SPOTenantCdnType + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantCdnPolicies -CdnType Public + + Returns the policies for the specified CDN type + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantRecycleBinItem + + * Supported in: SharePoint Online. + +Returns the items in the tenant scoped recycle bin + + + + + Get + PnPTenantRecycleBinItem + + + + This command will return all the items in the tenant recycle bin for the Office 365 tenant you are connected to. Be sure to connect to the SharePoint Online Admin endpoint (https://yourtenantname-admin.sharepoint.com) in order for this command to work. + + + + Get-PnPTenantRecycleBinItem + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.Online.SharePoint.TenantAdministration.DeletedSiteProperties + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantRecycleBinItem + + Returns all site collections in the tenant scoped recycle bin + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantSite + + * Supported in: SharePoint Online. + +Retrieve site information. + + + + + Get + PnPTenantSite + + + + Use this cmdlet to retrieve site information from your tenant administration. + + + + Get-PnPTenantSite + + Template + + By default, all sites will be returned. Specify a template value alike "STS#0" here to filter on the template + + String + + + Detailed + + By default, not all returned attributes are populated. This switch populates all attributes. It can take several seconds to run. Without this, some attributes will show default values that may not be correct. + + SwitchParameter + + + IncludeOneDriveSites + + By default, the OneDrives are not returned. This switch includes all OneDrives. + + SwitchParameter + + + Filter + + Specifies the script block of the server-side filter to apply. See https://technet.microsoft.com/en-us/library/fp161380.aspx + + String + + + Url + + The URL of the site + + String + + + 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. + + SPOnlineConnection + + + + + + Detailed + + By default, not all returned attributes are populated. This switch populates all attributes. It can take several seconds to run. Without this, some attributes will show default values that may not be correct. + + SwitchParameter + + SwitchParameter + + + + + Filter + + Specifies the script block of the server-side filter to apply. See https://technet.microsoft.com/en-us/library/fp161380.aspx + + String + + String + + + + + IncludeOneDriveSites + + By default, the OneDrives are not returned. This switch includes all OneDrives. + + SwitchParameter + + SwitchParameter + + + + + Template + + By default, all sites will be returned. Specify a template value alike "STS#0" here to filter on the template + + String + + String + + + + + Url + + The URL of the site + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.Online.SharePoint.TenantAdministration.SiteProperties + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantSite + + Returns all site collections + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantSite -Url http://tenant.sharepoint.com/sites/projects + + Returns information about the project site + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPTenantSite -Detailed + + Returns all sites with the full details of these sites + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPTenantSite -IncludeOneDriveSites + + Returns all sites including all OneDrive for Business sites + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPTenantSite -IncludeOneDriveSites -Filter "Url -like '-my.sharepoint.com/personal/'" + + Returns all OneDrive for Business sites + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPTenantSite -Template SITEPAGEPUBLISHING#0 + + Returns all Communication sites + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> Get-PnPTenantSite -Filter "Url -like 'sales'" + + Returns all sites including 'sales' in the url + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTenantTheme + + * Supported in: SharePoint Online. + +Returns all or a specific theme + + + + + Get + PnPTenantTheme + + + + Returns all or a specific tenant theme. + + + + Get-PnPTenantTheme + + Name + + The name of the theme to retrieve + + String + + + 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. + + SPOnlineConnection + + + + + + Name + + The name of the theme to retrieve + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTenantTheme + + Returns all themes + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantTheme -Name "MyCompanyTheme" + + Returns the specified theme + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTerm + + Returns a taxonomy term + + + + + Get + PnPTerm + + + + + Get-PnPTerm + + TermSet + + Name of the termset to check. + + Id, Title or TaxonomyItem + + + TermGroup + + Name of the termgroup to check. + + Id, Title or TermGroup + + + Identity + + The Id or Name of a Term + + Id, Name or Object + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + + Recursive + + Find the first term recursivly matching the label in a term hierarchy. + + SwitchParameter + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Id or Name of a Term + + Id, Name or Object + + Id, Name or Object + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + Recursive + + Find the first term recursivly matching the label in a term hierarchy. + + SwitchParameter + + SwitchParameter + + + + + TermGroup + + Name of the termgroup to check. + + Id, Title or TermGroup + + Id, Title or TermGroup + + + + + TermSet + + Name of the termset to check. + + Id, Title or TaxonomyItem + + Id, Title or TaxonomyItem + + + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.Term + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTerm -TermSet "Departments" -TermGroup "Corporate" + + Returns all term in the termset "Departments" which is in the group "Corporate" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTerm -Identity "Finance" -TermSet "Departments" -TermGroup "Corporate" + + Returns the term named "Finance" in the termset "Departments" from the termgroup called "Corporate" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPTerm -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermSet "Departments" -TermGroup "Corporate" + + Returns the term named with the given id, from the "Departments" termset in a term group called "Corporate" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPTerm -Identity "Small Finance" -TermSet "Departments" -TermGroup "Corporate" -Recursive + + Returns the term named "Small Finance", from the "Departments" termset in a term group called "Corporate" from the site collection termstore even if it's a subterm below "Finance" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTermGroup + + Returns a taxonomy term group + + + + + Get + PnPTermGroup + + + + + Get-PnPTermGroup + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + Name of the taxonomy term group to retrieve. + + Id, Title or TaxonomyItem + + + 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. + + SPOnlineConnection + + + + + + Identity + + Name of the taxonomy term group to retrieve. + + Id, Title or TaxonomyItem + + Id, Title or TaxonomyItem + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TermGroup + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTermGroup + + Returns all Term Groups in the site collection termstore + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTermGroup -Identity "Departments" + + Returns the termgroup named "Departments" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPTermGroup -Identity ab2af486-e097-4b4a-9444-527b251f1f8d + + Returns the termgroup with the given ID from the site collection termstore + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTermSet + + Returns a taxonomy term set + + + + + Get + PnPTermSet + + + + + Get-PnPTermSet + + TermGroup + + Name of the term group to check. + + Id, Title or TermGroup + + + Identity + + The Id or Name of a termset + + Id, Name or Object + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Id or Name of a termset + + Id, Name or Object + + Id, Name or Object + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + TermGroup + + Name of the term group to check. + + Id, Title or TermGroup + + Id, Title or TermGroup + + + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TermSet + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTermSet -TermGroup "Corporate" + + Returns all termsets in the group "Corporate" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTermSet -Identity "Departments" -TermGroup "Corporate" + + Returns the termset named "Departments" from the termgroup called "Corporate" from the site collection termstore + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPTermSet -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermGroup "Corporate + + Returns the termset with the given id from the termgroup called "Corporate" from the site collection termstore + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTheme + + Returns the current theme/composed look of the current web. + + + + + Get + PnPTheme + + + + + Get-PnPTheme + + DetectCurrentComposedLook + + Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + DetectCurrentComposedLook + + Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is. + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.ThemeEntity + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTheme + + Returns the current composed look of the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTheme -DetectCurrentComposedLook + + Returns the current composed look of the current web, and will try to detect the currently applied composed look based upon the actual site. Without this switch the cmdlet will first check for the presence of a property bag variable called _PnP_ProvisioningTemplateComposedLookInfo that contains composed look information when applied through the provisioning engine or the Set-PnPTheme cmdlet. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPTimeZoneId + + Returns a time zone ID + + + + + Get + PnPTimeZoneId + + + + In order to create a new classic site you need to specify the timezone this site will use. Use the cmdlet to retrieve a list of possible values. + + + + Get-PnPTimeZoneId + + Match + + A string to search for like 'Stockholm' + + String + + + + + + Match + + A string to search for like 'Stockholm' + + String + + String + + + + + + + + List<SharePointPnP.PowerShell.Commands.GetTimeZoneId+Zone> + + + Returns a list of matching zones. Use the ID property of the object for use in New-SPOTenantSite + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPTimeZoneId + + This will return all time zone IDs in use by Office 365. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTimeZoneId -Match Stockholm + + This will return the time zone IDs for Stockholm + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPUnifiedGroup + + * Supported in: SharePoint Online. + +Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups + + + + + Get + PnPUnifiedGroup + + + + + Get-PnPUnifiedGroup + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + + ExcludeSiteUrl + + Exclude fetching the site URL for Office 365 Groups. This speeds up large listings. + + SwitchParameter + + + + + + ExcludeSiteUrl + + Exclude fetching the site URL for Office 365 Groups. This speeds up large listings. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + UnifiedGroupPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPUnifiedGroup + + Retrieves all the Office 365 Groups + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPUnifiedGroup -Identity $groupId + + Retrieves a specific Office 365 Group based on its ID + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPUnifiedGroup -Identity $groupDisplayName + + Retrieves a specific or list of Office 365 Groups that start with the given DisplayName + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPUnifiedGroup -Identity $groupSiteMailNickName + + Retrieves a specific or list of Office 365 Groups for which the email starts with the provided mail nickName + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPUnifiedGroup -Identity $group + + Retrieves a specific Office 365 Group based on its object instance + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPUnifiedGroupMembers + + * Supported in: SharePoint Online. + +Gets members of a paricular Office 365 Group (aka Unified Group) + + + + + Get + PnPUnifiedGroupMembers + + + + + Get-PnPUnifiedGroupMembers + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + + + + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + UnifiedGroupPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPUnifiedGroupMembers -Identity $groupId + + Retrieves all the members of a specific Office 365 Group based on its ID + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPUnifiedGroupMembers -Identity $group + + Retrieves all the members of a specific Office 365 Group based on the group's object instance + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPUnifiedGroupOwners + + * Supported in: SharePoint Online. + +Gets owners of a paricular Office 365 Group (aka Unified Group) + + + + + Get + PnPUnifiedGroupOwners + + + + + Get-PnPUnifiedGroupOwners + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + + + + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + UnifiedGroupPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPUnifiedGroupOwners -Identity $groupId + + Retrieves all the owners of a specific Office 365 Group based on its ID + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPUnifiedGroupOwners -Identity $group + + Retrieves all the owners of a specific Office 365 Group based on the group's object instance + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPUser + + Returns site users of current web + + + + + Get + PnPUser + + + + This command will return all the users that exist in the current site collection its User Information List + + + + Get-PnPUser + + Identity + + User ID or login name + + UserPipeBind + + + WithRightsAssigned + + If provided, only users that currently have any kinds of access rights assigned to the current site collection will be returned. Otherwise all users, even those who previously had rights assigned, but not anymore at the moment, will be returned as the information is pulled from the User Information List. Only works if you don't provide an -Identity. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + User ID or login name + + UserPipeBind + + UserPipeBind + + + + + WithRightsAssigned + + If provided, only users that currently have any kinds of access rights assigned to the current site collection will be returned. Otherwise all users, even those who previously had rights assigned, but not anymore at the moment, will be returned as the information is pulled from the User Information List. Only works if you don't provide an -Identity. + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.User + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPUser + + Returns all users from the User Information List of the current site collection regardless if they currently have rights to access the current site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPUser -Identity 23 + + Returns the user with Id 23 from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com + + Returns the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com" + + Returns the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Get-PnPUser -WithRightsAssigned + + Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to the current site + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPUser -WithRightsAssigned -Web subsite1 + + Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to subsite 'subsite1' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPUserProfileProperty + + You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. + + + + + + Get + PnPUserProfileProperty + + + + Requires a connection to a SharePoint Tenant Admin site. + + + + Get-PnPUserProfileProperty + + Account + + The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com + + String[] + + + 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. + + SPOnlineConnection + + + + + + Account + + The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.UserProfiles.PersonProperties + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPUserProfileProperty -Account 'user@domain.com' + + Returns the profile properties for the specified user + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPUserProfileProperty -Account 'user@domain.com','user2@domain.com' + + Returns the profile properties for the specified users + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPView + + Returns one or all views from a list + + + + + Get + PnPView + + + + + Get-PnPView + + List + + The ID or Url of the list. + + ListPipeBind + + + Identity + + The ID or name of the view + + ViewPipeBind + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID or name of the view + + ViewPipeBind + + ViewPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + List + + The ID or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.View + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Get-PnPView -List "Demo List" + + Returns all views associated from the specified list + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Get-PnPView -List "Demo List" -Identity "Demo View" + + Returns the view called "Demo View" from the specified list + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + Get-PnPView -List "Demo List" -Identity "5275148a-6c6c-43d8-999a-d2186989a661" + + Returns the view with the specified ID from the specified list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWeb + + Returns the current web object + + + + + Get + PnPWeb + + + + + Get-PnPWeb + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + Identity + + The guid of the web or web object + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The guid of the web or web object + + WebPipeBind + + WebPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Web + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWeb + + This will return the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWebhookSubscriptions + + * Supported in: SharePoint Online. + +Gets all the Webhook subscriptions of the resource + + + + + Get + PnPWebhookSubscriptions + + + + + Get-PnPWebhookSubscriptions + + List + + The list object or name to get the Webhook subscriptions from + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + The list object or name to get the Webhook subscriptions from + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.WebhookSubscription + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWebhookSubscriptions -List MyList + + Gets all Webhook subscriptions of the list MyList + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWebPart + + Returns a webpart definition object + + + + + Get + PnPWebPart + + + + + Get-PnPWebPart + + ServerRelativePageUrl + + Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + + Identity + + The identity of the webpart, this can be the webpart guid or an webpart object + + WebPartPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The identity of the webpart, this can be the webpart guid or an webpart object + + WebPartPipeBind + + WebPartPipeBind + + + + + ServerRelativePageUrl + + Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + List<Microsoft.SharePoint.Client.WebParts.WebPartDefinition> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" + + Returns all webparts defined on the given page. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 + + Returns a specific webpart defined on the given page. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWebPartProperty + + Returns a web part property + + + + + Get + PnPWebPartProperty + + + + + Get-PnPWebPartProperty + + ServerRelativePageUrl + + Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + + Identity + + The id of the webpart + + GuidPipeBind + + + Key + + Name of a single property to be returned + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The id of the webpart + + GuidPipeBind + + GuidPipeBind + + + + + Key + + Name of a single property to be returned + + String + + String + + + + + ServerRelativePageUrl + + Full server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 + + Returns all properties of the webpart. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" + + Returns the title property of the webpart. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWebPartXml + + Returns the webpart XML of a webpart registered on a site + + + + + Get + PnPWebPartXml + + + + + Get-PnPWebPartXml + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + + Identity + + Id or title of the webpart. Use Get-PnPWebPart to retrieve all webpart Ids + + WebPartPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Id or title of the webpart. Use Get-PnPWebPart to retrieve all webpart Ids + + WebPartPipeBind + + WebPartPipeBind + + + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/mysite/sitepages/home.aspx + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWebPartXml -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 + + Returns the webpart XML for a given webpart on a page. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWebTemplates + + * Supported in: SharePoint Online. + +Returns the available web templates. + + + + + Get + PnPWebTemplates + + + + Will list all available templates one can use to create a classic site. + + + + Get-PnPWebTemplates + + Lcid + + The language ID. For instance: 1033 for English + + UInt32 + + + CompatibilityLevel + + The version of SharePoint + + Int32 + + + 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. + + SPOnlineConnection + + + + + + CompatibilityLevel + + The version of SharePoint + + Int32 + + Int32 + + + + + Lcid + + The language ID. For instance: 1033 for English + + UInt32 + + UInt32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplateCollection + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWebTemplates + + + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWebTemplates -LCID 1033 + + Returns all webtemplates for the Locale with ID 1033 (English) + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPWebTemplates -CompatibilityLevel 15 + + Returns all webtemplates for the compatibility level 15 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Locale IDs: + http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911 + + + + + + Get-PnPWikiPageContent + + Gets the contents/source of a wiki page + + + + + Get + PnPWikiPageContent + + + + + Get-PnPWikiPageContent + + ServerRelativePageUrl + + The server relative URL for the wiki page + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ServerRelativePageUrl + + The server relative URL for the wiki page + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + System.String + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWikiPageContent -PageUrl '/sites/demo1/pages/wikipage.aspx' + + Gets the content of the page '/sites/demo1/pages/wikipage.aspx' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWorkflowDefinition + + Returns a workflow definition + + + + + Get + PnPWorkflowDefinition + + + + Returns a workflow definition + + + + Get-PnPWorkflowDefinition + + PublishedOnly + + Return only the published workflows + + SwitchParameter + + + Name + + The name of the workflow + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Name + + The name of the workflow + + String + + String + + + + + PublishedOnly + + Return only the published workflows + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.WorkflowServices.WorkflowDefinition + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWorkflowDefinition -Name MyWorkflow + + Gets a Workflow with the name "MyWorkflow". + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWorkflowDefinition -Name MyWorkflow -PublishedOnly $false + + Gets a Workflow with the name "MyWorkflow" that is published. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWorkflowInstance + + Get workflow instances + + + + + Get + PnPWorkflowInstance + + + + Gets all workflow instances + + + + Get-PnPWorkflowInstance + + List + + The List for which workflow instances should be retrieved + + ListPipeBind + + + ListItem + + The List Item for which workflow instances should be retrieved + + ListItemPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + The List for which workflow instances should be retrieved + + ListPipeBind + + ListPipeBind + + + + + ListItem + + The List Item for which workflow instances should be retrieved + + ListItemPipeBind + + ListItemPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem $ListItem + + Retrieves workflow instances running against the provided item on list "My Library" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem 2 + + Retrieves workflow instances running against the provided item with 2 in the list "My Library" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Get-PnPWorkflowSubscription + + Return a workflow subscription + + + + + Get + PnPWorkflowSubscription + + + + Returns a workflow subscriptions from a list + + + + Get-PnPWorkflowSubscription + + Name + + The name of the workflow + + String + + + List + + A list to search the association for + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + List + + A list to search the association for + + ListPipeBind + + ListPipeBind + + + + + Name + + The name of the workflow + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.WorkflowServices.WorkflowSubscription + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPWorkflowSubscription -Name MyWorkflow + + Gets an Workflow subscription with the name "MyWorkflow". + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWorkflowSubscription -Name MyWorkflow -list $list + + Gets an Workflow subscription with the name "MyWorkflow" from the list $list. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPList -identity "MyList" | Get-PnPWorkflowSubscription -Name MyWorkflow + + Gets an Workflow subscription with the name "MyWorkflow" from the list "MyList". + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Grant-PnPHubSiteRights + + * Supported in: SharePoint Online. + +Retrieve all or a specific hubsite. + + + + + Grant + PnPHubSiteRights + + + + + Grant-PnPHubSiteRights + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Get-PnPStorageEntity + + Returns all site storage entities/farm properties + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantSite -Key MyKey + + Returns the storage entity/farm property with the given key. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Grant-PnPSiteDesignRights + + * Supported in: SharePoint Online. + +Grants the specified principals rights to use the site design. + + + + + Grant + PnPSiteDesignRights + + + + + Grant-PnPSiteDesignRights + + Principals + + One or more principals to grant rights to. + + String[] + + + Identity + + The site design to use. + + TenantSiteDesignPipeBind + + + Rights + + The rights to set. Defaults to 'View' + + TenantSiteDesignPrincipalRights + + + 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. + + SPOnlineConnection + + + + + + Identity + + The site design to use. + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + Principals + + One or more principals to grant rights to. + + String[] + + String[] + + + + + Rights + + The rights to set. Defaults to 'View' + + TenantSiteDesignPrincipalRights + + TenantSiteDesignPrincipalRights + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Grant-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com" + + Grants the specified principals View rights on the site design specified + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSiteDesign -Title "MySiteDesign" -SiteScriptIds 438548fd-60dd-42cf-b843-2db506c8e259 -WebTemplate TeamSite | Grant-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com" + + Grants the specified principals View rights on the site design specified + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Import-PnPAppPackage + + Adds a SharePoint Addin to a site + + + + + Import + PnPAppPackage + + + + This commands requires that you have an addin package to deploy + + + + Import-PnPAppPackage + + Path + + Path pointing to the .app file + + String + + + Force + + Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature + + SwitchParameter + + + LoadOnly + + Will only upload the addin, but not install it + + SwitchParameter + + + Locale + + Will install the addin for the specified locale + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature + + SwitchParameter + + SwitchParameter + + + + + LoadOnly + + Will only upload the addin, but not install it + + SwitchParameter + + SwitchParameter + + + + + Locale + + Will install the addin for the specified locale + + Int32 + + Int32 + + + + + Path + + Path pointing to the .app file + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.AppInstance + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Import-PnPAppPackage -Path c:\files\demo.app -LoadOnly + + This will load the addin in the demo.app package, but will not install it to the site. + + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Import-PnPAppPackage -Path c:\files\demo.app -Force + + This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature. + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Import-PnPTaxonomy + + Imports a taxonomy from either a string array or a file + + + + + Import + PnPTaxonomy + + + + + Import-PnPTaxonomy + + Terms + + An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'. + + String[] + + + Lcid + + + + Int32 + + + TermStoreName + + Term store to import to; if not specified the default term store is used. + + String + + + Delimiter + + The path delimiter to be used, by default this is '|' + + String + + + SynchronizeDeletions + + If specified, terms that exist in the termset, but are not in the imported data, will be removed. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Import-PnPTaxonomy + + Path + + Specifies a file containing terms per line, in the format as required by the Terms parameter. + + String + + + Lcid + + + + Int32 + + + TermStoreName + + Term store to import to; if not specified the default term store is used. + + String + + + Delimiter + + The path delimiter to be used, by default this is '|' + + String + + + SynchronizeDeletions + + If specified, terms that exist in the termset, but are not in the imported data, will be removed. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Delimiter + + The path delimiter to be used, by default this is '|' + + String + + String + + + + + Lcid + + + + Int32 + + Int32 + + + + + Path + + Specifies a file containing terms per line, in the format as required by the Terms parameter. + + String + + String + + + + + SynchronizeDeletions + + If specified, terms that exist in the termset, but are not in the imported data, will be removed. + + SwitchParameter + + SwitchParameter + + + + + Terms + + An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'. + + String[] + + String[] + + + + + TermStoreName + + Term store to import to; if not specified the default term store is used. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm' + + Creates a new termgroup, 'Company', a termset 'Locations' and a term 'Stockholm' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm|Central','Company|Locations|Stockholm|North' + + Creates a new termgroup, 'Company', a termset 'Locations', a term 'Stockholm' and two subterms: 'Central', and 'North' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Import-PnPTermGroupFromXml + + Imports a taxonomy TermGroup from either the input or from an XML file. + + + + + Import + PnPTermGroupFromXml + + + + + Import-PnPTermGroupFromXml + + Xml + + The XML to process + + String + + + 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. + + SPOnlineConnection + + + + Import-PnPTermGroupFromXml + + Path + + The XML File to import the data from + + String + + + 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. + + SPOnlineConnection + + + + + + Path + + The XML File to import the data from + + String + + String + + + + + Xml + + The XML to process + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Import-PnPTermGroupFromXml -Xml $xml + + Imports the XML based termgroup information located in the $xml variable + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Import-PnPTermGroupFromXml -Path input.xml + + Imports the XML file specified by the path. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Import-PnPTermSet + + Imports a taxonomy term set from a file in the standard format. + + + + + Import + PnPTermSet + + + + The format of the file is the same as that used by the import function in the web interface. A sample file can be obtained from the web interface. + +This is a CSV file, with the following headings: + + Term Set Name,Term Set Description,LCID,Available for Tagging,Term Description,Level 1 Term,Level 2 Term,Level 3 Term,Level 4 Term,Level 5 Term,Level 6 Term,Level 7 Term + +The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. + +It is recommended that a fixed GUID be used as the termSetId, to allow the term set to be easily updated (so do not pass Guid.Empty). + +In contrast to the web interface import, this is not a one-off import but runs synchronisation logic allowing updating of an existing Term Set. When synchronising, any existing terms are matched (with Term Description and Available for Tagging updated as necessary), any new terms are added in the correct place in the hierarchy, and (if synchroniseDeletions is set) any terms not in the imported file are removed. + +The import file also supports an expanded syntax for the Term Set Name and term names (Level 1 Term, Level 2 Term, etc). These columns support values with the format 'Name | GUID', with the name and GUID separated by a pipe character (note that the pipe character is invalid to use within a taxomony item name). This expanded syntax is not required, but can be used to ensure all terms have fixed IDs. + + + + Import-PnPTermSet + + GroupName + + Group to import the term set to; an error is returned if the group does not exist. + + String + + + Path + + Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration). + + String + + + TermSetId + + GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + + SynchronizeDeletions + + If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them. + + SwitchParameter + + + IsOpen + + Whether the term set should be marked open; if not specified, then the existing setting is not changed. + + Boolean + + + Contact + + Contact for the term set; if not specified, the existing setting is retained. + + String + + + Owner + + Owner for the term set; if not specified, the existing setting is retained. + + String + + + TermStoreName + + Term store to import into; if not specified the default term store is used. + + String + + + 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. + + SPOnlineConnection + + + + + + Contact + + Contact for the term set; if not specified, the existing setting is retained. + + String + + String + + + + + GroupName + + Group to import the term set to; an error is returned if the group does not exist. + + String + + String + + + + + IsOpen + + Whether the term set should be marked open; if not specified, then the existing setting is not changed. + + Boolean + + Boolean + + + + + Owner + + Owner for the term set; if not specified, the existing setting is retained. + + String + + String + + + + + Path + + Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration). + + String + + String + + + + + SynchronizeDeletions + + If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them. + + SwitchParameter + + SwitchParameter + + + + + TermSetId + + GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + Guid + + + + + TermStoreName + + Term store to import into; if not specified the default term store is used. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -SynchronizeDeletions + + Creates (or updates) the term set specified in the import file, in the group specified, removing any existing terms not in the file. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Import-PnPTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' + + Creates (or updates) the term set specified in the import file, in the term store and group specified, using the specified ID. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -IsOpen $true -Contact 'user@example.org' -Owner 'user@example.org' + + Creates (or updates) the term set specified in the import file, setting the IsOpen, Contact, and Owner properties as specified. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Install-PnPApp + + * Supported in: SharePoint Online. + +Installs an available app from the app catalog + + + + + Install + PnPApp + + + + + Install-PnPApp + + Identity + + Specifies the Id or an actual app metadata instance + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id or an actual app metadata instance + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will install an available app, specified by the id, to the current site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp + + This will install the given app into the site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Install-PnPSolution + + Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that. + + + + + Install + PnPSolution + + + + + Install-PnPSolution + + PackageId + + ID of the solution, from the solution manifest + + GuidPipeBind + + + SourceFilePath + + Path to the sandbox solution package (.WSP) file + + String + + + MajorVersion + + Optional major version of the solution, defaults to 1 + + Int32 + + + MinorVersion + + Optional minor version of the solution, defaults to 0 + + Int32 + + + 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. + + SPOnlineConnection + + + + + + MajorVersion + + Optional major version of the solution, defaults to 1 + + Int32 + + Int32 + + + + + MinorVersion + + Optional minor version of the solution, defaults to 0 + + Int32 + + Int32 + + + + + PackageId + + ID of the solution, from the solution manifest + + GuidPipeBind + + GuidPipeBind + + + + + SourceFilePath + + Path to the sandbox solution package (.WSP) file + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Install-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -SourceFilePath mypackage.wsp + + Installs the package to the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Invoke-PnPQuery + + Executes the currently queued actions + + + + + Invoke + PnPQuery + + + + Executes any queued actions / changes on the SharePoint Client Side Object Model Context + + + + Invoke-PnPQuery + + RetryCount + + Number of times to retry in case of throttling. Defaults to 10. + + Int32 + + + RetryWait + + Delay in seconds. Defaults to 1. + + Int32 + + + 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. + + SPOnlineConnection + + + + + + RetryCount + + Number of times to retry in case of throttling. Defaults to 10. + + Int32 + + Int32 + + + + + RetryWait + + Delay in seconds. Defaults to 1. + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Invoke-PnPQuery -RetryCount 5 + + This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and will retry 5 times in case of throttling. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Invoke-PnPQuery -RetryWait 10 + + This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and delay the execution for 10 seconds before it retries the execution. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Invoke-PnPSiteDesign + + * Supported in: SharePoint Online. + +Apply a Site Design to an existing site. * Requires Tenant Administration Rights * + + + + + Invoke + PnPSiteDesign + + + + + Invoke-PnPSiteDesign + + Identity + + The Site Design Id or an actual Site Design object to apply + + TenantSiteDesignPipeBind + + + WebUrl + + The URL of the web to apply the site design to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Site Design Id or an actual Site Design object to apply + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + WebUrl + + The URL of the web to apply the site design to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Applies the specified site design to the current site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -WebUrl https://contoso.sharepoint.com/sites/mydemosite + + Applies the specified site design to the specified site. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSiteDesign | ?{$_.Title -eq "Demo"} | Invoke-PnPSiteDesign + + Applies the specified site design to the specified site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Invoke-PnPWebAction + + Executes operations on web, lists and list items. + + + + + Invoke + PnPWebAction + + + + + Invoke-PnPWebAction + + Webs + + Webs you want to process (for example different site collections), will use Web parameter if not specified + + Web[] + + + WebAction + + Function to be executed on the web. There is one input parameter of type Web + + Web + + + ShouldProcessWebAction + + Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value + + Web + + + PostWebAction + + Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web + + Web + + + ShouldProcessPostWebAction + + Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value + + Web + + + WebProperties + + The properties to load for web. + + String[] + + + ListAction + + Function to be executed on the list. There is one input parameter of type List + + List + + + ShouldProcessListAction + + Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value + + List + + + PostListAction + + Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List + + List + + + ShouldProcessPostListAction + + Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value + + List + + + ListProperties + + The properties to load for list. + + String[] + + + ListItemAction + + Function to be executed on the list item. There is one input parameter of type ListItem + + ListItem + + + ShouldProcessListItemAction + + Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value + + ListItem + + + ListItemProperties + + The properties to load for list items. + + String[] + + + SubWebs + + Specify if sub webs will be processed + + SwitchParameter + + + DisableStatisticsOutput + + Will not output statistics after the operation + + SwitchParameter + + + SkipCounting + + Will skip the counting process; by doing this you will not get an estimated time remaining + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + DisableStatisticsOutput + + Will not output statistics after the operation + + SwitchParameter + + SwitchParameter + + + + + ListAction + + Function to be executed on the list. There is one input parameter of type List + + List + + List + + + + + ListItemAction + + Function to be executed on the list item. There is one input parameter of type ListItem + + ListItem + + ListItem + + + + + ListItemProperties + + The properties to load for list items. + + String[] + + String[] + + + + + ListProperties + + The properties to load for list. + + String[] + + String[] + + + + + PostListAction + + Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List + + List + + List + + + + + PostWebAction + + Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web + + Web + + Web + + + + + ShouldProcessListAction + + Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value + + List + + List + + + + + ShouldProcessListItemAction + + Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value + + ListItem + + ListItem + + + + + ShouldProcessPostListAction + + Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value + + List + + List + + + + + ShouldProcessPostWebAction + + Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value + + Web + + Web + + + + + ShouldProcessWebAction + + Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value + + Web + + Web + + + + + SkipCounting + + Will skip the counting process; by doing this you will not get an estimated time remaining + + SwitchParameter + + SwitchParameter + + + + + SubWebs + + Specify if sub webs will be processed + + SwitchParameter + + SwitchParameter + + + + + WebAction + + Function to be executed on the web. There is one input parameter of type Web + + Web + + Web + + + + + WebProperties + + The properties to load for web. + + String[] + + String[] + + + + + Webs + + Webs you want to process (for example different site collections), will use Web parameter if not specified + + Web[] + + Web[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Invoke-PnPWebAction -ListAction ${function:ListAction} + + This will call the function ListAction on all the lists located on the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Invoke-PnPWebAction -ShouldProcessListAction ${function:ShouldProcessList} -ListAction ${function:ListAction} + + This will call the function ShouldProcessList, if it returns true the function ListAction will then be called. This will occur on all lists located on the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Measure-PnPList + + * Supported in: SharePoint Online, SharePoint 2016. + +Returns statistics on the list object + + + + + Measure + PnPList + + + + + Measure-PnPList + + Identity + + + + ListPipeBind + + + ItemLevel + + Show item level statistics + + SwitchParameter + + + BrokenPermissions + + Show items with broken permissions + + SwitchParameter + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + BrokenPermissions + + Show items with broken permissions + + SwitchParameter + + SwitchParameter + + + + + Identity + + + + ListPipeBind + + ListPipeBind + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + ItemLevel + + Show item level statistics + + SwitchParameter + + SwitchParameter + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Measure-PnPList "Documents" + + Gets statistics on Documents document library + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Measure-PnPList "Documents" -BrokenPermissions -ItemLevel + + Displays items and folders with broken permissions inside Documents library + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Measure-PnPWeb + + * Supported in: SharePoint Online, SharePoint 2016. + +Returns statistics on the web object + + + + + Measure + PnPWeb + + + + + Measure-PnPWeb + + Recursive + + Iterate all sub webs recursively + + SwitchParameter + + + IncludeHiddenList + + Include hidden lists in statistics calculation + + SwitchParameter + + + Identity + + + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + + + WebPipeBind + + WebPipeBind + + + + + IncludeHiddenList + + Include hidden lists in statistics calculation + + SwitchParameter + + SwitchParameter + + + + + Recursive + + Iterate all sub webs recursively + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Measure-PnPWeb + + Gets statistics on the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Measure-PnPList $web -Recursive + + Gets statistics on the chosen including all sub webs + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Measure-PnPResponseTime + + Gets statistics on response time for the specified endpoint by sending probe requests + + + + + Measure + PnPResponseTime + + + + + Measure-PnPResponseTime + + Count + + Number of probe requests to send + + UInt32 + + + WarmUp + + Number of warm up requests to send before start calculating statistics + + UInt32 + + + Timeout + + Idle timeout between requests to avoid request throttling + + UInt32 + + + Histogram + + Number of buckets in histogram in output statistics + + UInt32 + + + Mode + + Response time measurement mode. RoundTrip - measures full request round trip. SPRequestDuration - measures server processing time only, based on SPRequestDuration HTTP header. Latency - difference between RoundTrip and SPRequestDuration + + MeasureResponseTimeMode + + + Url + + + + DiagnosticEndpointPipeBind + + + 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. + + SPOnlineConnection + + + + + + Count + + Number of probe requests to send + + UInt32 + + UInt32 + + + + + Histogram + + Number of buckets in histogram in output statistics + + UInt32 + + UInt32 + + + + + Mode + + Response time measurement mode. RoundTrip - measures full request round trip. SPRequestDuration - measures server processing time only, based on SPRequestDuration HTTP header. Latency - difference between RoundTrip and SPRequestDuration + + MeasureResponseTimeMode + + MeasureResponseTimeMode + + + + + Timeout + + Idle timeout between requests to avoid request throttling + + UInt32 + + UInt32 + + + + + Url + + + + DiagnosticEndpointPipeBind + + DiagnosticEndpointPipeBind + + + + + WarmUp + + Number of warm up requests to send before start calculating statistics + + UInt32 + + UInt32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Measure-PnPResponseTime -Count 100 -Timeout 20 + + Calculates statistics on sequence of 100 probe requests, sleeps 20ms between probes + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Measure-PnPResponseTime "/Pages/Test.aspx" -Count 1000 + + Calculates statistics on response time of Test.aspx by sending 1000 requests with default sleep time between requests + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Measure-PnPResponseTime $web -Count 1000 -WarmUp 10 -Histogram 20 -Timeout 50 | Select -expa Histogram | % {$_.GetEnumerator() | Export-Csv C:\Temp\responsetime.csv -NoTypeInformation} + + Builds histogram of response time for the home page of the web and exports to CSV for later processing in Excel + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPClientSideComponent + + * Supported in: SharePoint Online. + +Moves a Client-Side Component to a different section/column + + + + + Move + PnPClientSideComponent + + + + Moves a Client-Side Component to a different location on the page. Notice that the sections and or columns need to be present before moving the component. + + + + Move-PnPClientSideComponent + + Section + + The section to move the webpart to + + Int32 + + + InstanceId + + The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. + + GuidPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Position + + Change to order of the webpart in the column + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Move-PnPClientSideComponent + + Column + + The column to move the webpart to + + Int32 + + + InstanceId + + The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. + + GuidPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Position + + Change to order of the webpart in the column + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Move-PnPClientSideComponent + + Position + + Change to order of the webpart in the column + + Int32 + + + InstanceId + + The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. + + GuidPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Move-PnPClientSideComponent + + Section + + The section to move the webpart to + + Int32 + + + Column + + The column to move the webpart to + + Int32 + + + InstanceId + + The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. + + GuidPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Position + + Change to order of the webpart in the column + + Int32 + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Column + + The column to move the webpart to + + Int32 + + Int32 + + + + + InstanceId + + The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids. + + GuidPipeBind + + GuidPipeBind + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + Position + + Change to order of the webpart in the column + + Int32 + + Int32 + + + + + Section + + The section to move the webpart to + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 + + Moves the specified component to the first section of the page. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Column 2 + + Moves the specified component to the second column of the current section. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2 + + Moves the specified component to the first section of the page into the second column. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2 -Position 2 + + Moves the specified component to the first section of the page into the second column and sets the column to position 2 in the list of webparts. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPFile + + Moves a file to a different location + + + + + Move + PnPFile + + + + + Move-PnPFile + + ServerRelativeUrl + + Server relative Url specifying the file to move. Must include the file name. + + String + + + TargetUrl + + Server relative Url where to move the file to. Must include the file name. + + String + + + OverwriteIfAlreadyExists + + If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the move operation will be canceled if the file already exists at the TargetUrl location. + + SwitchParameter + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Move-PnPFile + + SiteRelativeUrl + + Site relative Url specifying the file to move. Must include the file name. + + String + + + TargetUrl + + Server relative Url where to move the file to. Must include the file name. + + String + + + OverwriteIfAlreadyExists + + If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the move operation will be canceled if the file already exists at the TargetUrl location. + + SwitchParameter + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + SwitchParameter + + + + + OverwriteIfAlreadyExists + + If provided, if a file already exists at the TargetUrl, it will be overwritten. If ommitted, the move operation will be canceled if the file already exists at the TargetUrl location. + + SwitchParameter + + SwitchParameter + + + + + ServerRelativeUrl + + Server relative Url specifying the file to move. Must include the file name. + + String + + String + + + + + SiteRelativeUrl + + Site relative Url specifying the file to move. Must include the file name. + + String + + String + + + + + TargetUrl + + Server relative Url where to move the file to. Must include the file name. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx + + Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:>Move-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetUrl /sites/otherproject/Documents/company.docx + + Moves a file named company.docx located in the document library called Documents located in the current site to the Documents library in the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists + + Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it will still perform the move and replace the original company.aspx file. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPFolder + + Move a folder to another location in the current web + + + + + Move + PnPFolder + + + + + Move-PnPFolder + + Folder + + The folder to move + + String + + + TargetFolder + + The new parent location to which the folder should be moved to + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + The folder to move + + String + + String + + + + + TargetFolder + + The new parent location to which the folder should be moved to + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Folder + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Move-PnPFolder -Folder Documents/Reports -TargetFolder 'Archived Reports' + + This will move the folder Reports in the Documents library to the 'Archived Reports' library + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Move-PnPFolder -Folder 'Shared Documents/Reports/2016/Templates' -TargetFolder 'Shared Documents/Reports' + + This will move the folder Templates to the new location in 'Shared Documents/Reports' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPListItemToRecycleBin + + Moves an item from a list to the Recycle Bin + + + + + Move + PnPListItemToRecycleBin + + + + + Move-PnPListItemToRecycleBin + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Move-PnPListItemToRecycleBin -List "Demo List" -Identity "1" -Force + + Moves the listitem with id "1" from the "Demo List" list to the Recycle Bin. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPRecycleBinItem + + * Supported in: SharePoint Online. + +Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin + + + + + Move + PnPRecycleBinItem + + + + + Move-PnPRecycleBinItem + + Identity + + If provided, moves the item with the specific ID to the second stage recycle bin + + RecycleBinItemPipeBind + + + Force + + If provided, no confirmation will be asked to move the first stage recycle bin items to the second stage + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be asked to move the first stage recycle bin items to the second stage + + SwitchParameter + + SwitchParameter + + + + + Identity + + If provided, moves the item with the specific ID to the second stage recycle bin + + RecycleBinItemPipeBind + + RecycleBinItemPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Move-PnpRecycleBinItem + + Moves all the items in the first stage recycle bin of the current site collection to the second stage recycle bin + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Move-PnpRecycleBinItem -Identity 26ffff29-b526-4451-9b6f-7f0e56ba7125 + + Moves the item with the provided ID in the first stage recycle bin of the current site collection to the second stage recycle bin without asking for confirmation first + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Move-PnpRecycleBinItem -Force + + Moves all the items in the first stage recycle bin of the current context to the second stage recycle bin without asking for confirmation first + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPExtensibilityHandlerObject + + Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet + + + + + New + PnPExtensibilityHandlerObject + + + + + New-PnPExtensibilityHandlerObject + + Type + + The type of the handler + + String + + + Assembly + + The full assembly name of the handler + + String + + + Configuration + + Any configuration data you want to send to the handler + + String + + + Disabled + + If set, the handler will be disabled + + SwitchParameter + + + + + + Assembly + + The full assembly name of the handler + + String + + String + + + + + Configuration + + Any configuration data you want to send to the handler + + String + + String + + + + + Disabled + + If set, the handler will be disabled + + SwitchParameter + + SwitchParameter + + + + + Type + + The type of the handler + + String + + String + + + + + + + + OfficeDevPnP.Core.Framework.Provisioning.Model.ExtensibilityHandler + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + +PS:> $handler = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler +PS:> Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler + + This will create a new ExtensibilityHandler object that is run during extraction of the template + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPGroup + + Adds group to the Site Groups List and returns a group object + + + + + New + PnPGroup + + + + + New-PnPGroup + + Title + + The Title of the group + + String + + + Description + + The description for the group + + String + + + Owner + + The owner for the group, which can be a user or another group + + String + + + AllowRequestToJoinLeave + + A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group + + SwitchParameter + + + AutoAcceptRequestToJoinLeave + + A switch parameter that specifies whether users are automatically added or removed when they make a request + + SwitchParameter + + + AllowMembersEditMembership + + A switch parameter that specifies whether group members can modify membership in the group + + SwitchParameter + + + DisallowMembersViewMembership + + A switch parameter that disallows group members to view membership. + + SwitchParameter + + + RequestToJoinEmail + + The e-mail address to which membership requests are sent + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AllowMembersEditMembership + + A switch parameter that specifies whether group members can modify membership in the group + + SwitchParameter + + SwitchParameter + + + + + AllowRequestToJoinLeave + + A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group + + SwitchParameter + + SwitchParameter + + + + + AutoAcceptRequestToJoinLeave + + A switch parameter that specifies whether users are automatically added or removed when they make a request + + SwitchParameter + + SwitchParameter + + + + + Description + + The description for the group + + String + + String + + + + + DisallowMembersViewMembership + + A switch parameter that disallows group members to view membership. + + SwitchParameter + + SwitchParameter + + + + + Owner + + The owner for the group, which can be a user or another group + + String + + String + + + + + RequestToJoinEmail + + The e-mail address to which membership requests are sent + + String + + String + + + + + Title + + The Title of the group + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Group + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPGroup -Title "My Site Users" + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPList + + Creates a new list + + + + + New + PnPList + + + + + New-PnPList + + Title + + The Title of the list + + String + + + Template + + The type of list to create. + + ListTemplateType + + + Url + + If set, will override the url of the list. + + String + + + Hidden + + Switch parameter if list should be hidden from the SharePoint UI + + SwitchParameter + + + EnableVersioning + + Switch parameter if versioning should be enabled + + SwitchParameter + + + EnableContentTypes + + Switch parameter if content types should be enabled on this list + + SwitchParameter + + + OnQuickLaunch + + Switch parameter if this list should be visible on the QuickLaunch + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + EnableContentTypes + + Switch parameter if content types should be enabled on this list + + SwitchParameter + + SwitchParameter + + + + + EnableVersioning + + Switch parameter if versioning should be enabled + + SwitchParameter + + SwitchParameter + + + + + Hidden + + Switch parameter if list should be hidden from the SharePoint UI + + SwitchParameter + + SwitchParameter + + + + + OnQuickLaunch + + Switch parameter if this list should be visible on the QuickLaunch + + SwitchParameter + + SwitchParameter + + + + + Template + + The type of list to create. + + ListTemplateType + + ListTemplateType + + + + + Title + + The Title of the list + + String + + String + + + + + Url + + If set, will override the url of the list. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPList -Title Announcements -Template Announcements + + Create a new announcements list + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> New-PnPList -Title "Demo List" -Url "DemoList" -Template Announcements + + Create a list with a title that is different from the url + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> New-PnPList -Title HiddenList -Template GenericList -Hidden + + Create a new custom list and hides it from the SharePoint UI. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPPersonalSite + + * Supported in: SharePoint Online. + +Office365 only: Creates a personal / OneDrive For Business site + + + + + New + PnPPersonalSite + + + + + New-PnPPersonalSite + + Email + + The UserPrincipalName (UPN) of the users + + String[] + + + 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. + + SPOnlineConnection + + + + + + Email + + The UserPrincipalName (UPN) of the users + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $users = ('katiej@contoso.onmicrosoft.com','garth@contoso.onmicrosoft.com') + PS:> New-PnPPersonalSite -Email $users + + Creates a personal / OneDrive For Business site for the 2 users in the variable $users + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPAzureCertificate + + Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. + +See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. + +KeyCredentials contains the ADAL app manifest sections. + +Certificate contains the PEM encoded certificate. + +PrivateKey contains the PEM encoded private key of the certificate. + + + + + New + PnPAzureCertificate + + + + + New-PnPAzureCertificate + + CommonName + + Common Name (e.g. server FQDN or YOUR name) [pnp.contoso.com] + + String + + + Country + + Country Name (2 letter code) + + String + + + State + + State or Province Name (full name) + + String + + + Locality + + Locality Name (eg, city) + + String + + + Organization + + Organization Name (eg, company) + + String + + + OrganizationUnit + + Organizational Unit Name (eg, section) + + String + + + Out + + Filename to write to, optionally including full path (.pfx) + + String + + + ValidYears + + Number of years until expiration (default is 10, max is 30) + + Int32 + + + + + + CommonName + + Common Name (e.g. server FQDN or YOUR name) [pnp.contoso.com] + + String + + String + + + + + Country + + Country Name (2 letter code) + + String + + String + + + + + Locality + + Locality Name (eg, city) + + String + + String + + + + + Organization + + Organization Name (eg, company) + + String + + String + + + + + OrganizationUnit + + Organizational Unit Name (eg, section) + + String + + String + + + + + Out + + Filename to write to, optionally including full path (.pfx) + + String + + String + + + + + State + + State or Province Name (full name) + + String + + String + + + + + ValidYears + + Number of years until expiration (default is 10, max is 30) + + Int32 + + Int32 + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Generate-PnPAzureCertificate + + This will generate a default self-signed certificate named "pnp.contoso.com" valid for 10 years. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Generate-PnPAzureCertificate -CommonName "My Certificate" -ValidYears 30 + + This will output a certificate named "My Certificate" which expires in 30 years from now. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPUnifiedGroup + + * Supported in: SharePoint Online. + +Creates a new Office 365 Group (aka Unified Group) + + + + + New + PnPUnifiedGroup + + + + + New-PnPUnifiedGroup + + DisplayName + + The Display Name of the Office 365 Group. + + String + + + Description + + The Description of the Office 365 Group. + + String + + + MailNickname + + The Mail Nickname of the Office 365 Group. Cannot contain spaces. + + String + + + Owners + + The array UPN values of the group's owners. + + String[] + + + Members + + The array UPN values of the group's members. + + String[] + + + IsPrivate + + Makes the group private when selected. + + SwitchParameter + + + GroupLogoPath + + The path to the logo file of to set. + + String + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + + + + Description + + The Description of the Office 365 Group. + + String + + String + + + + + DisplayName + + The Display Name of the Office 365 Group. + + String + + String + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + GroupLogoPath + + The path to the logo file of to set. + + String + + String + + + + + IsPrivate + + Makes the group private when selected. + + SwitchParameter + + SwitchParameter + + + + + MailNickname + + The Mail Nickname of the Office 365 Group. Cannot contain spaces. + + String + + String + + + + + Members + + The array UPN values of the group's members. + + String[] + + String[] + + + + + Owners + + The array UPN values of the group's owners. + + String[] + + String[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname + + Creates a public Office 365 Group with all the required properties + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers + + Creates a public Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -IsPrivate + + Creates a private Office 365 Group with all the required properties + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers -IsPrivate + + Creates a private Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPProvisioningTemplate + + Creates a new provisioning template object + + + + + New + PnPProvisioningTemplate + + + + + New-PnPProvisioningTemplate + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> $template = New-PnPProvisioningTemplate + + Creates a new instance of a provisioning template object. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPProvisioningTemplateFromFolder + + Generates a provisioning template from a given folder, including only files that are present in that folder + + + + + New + PnPProvisioningTemplateFromFolder + + + + + New-PnPProvisioningTemplateFromFolder + + Match + + Optional wildcard pattern to match filenames against. If empty all files will be included. + + String + + + ContentType + + An optional content type to use. + + ContentTypePipeBind + + + Properties + + Additional properties to set for every file entry in the generated template. + + Hashtable + + + AsIncludeFile + + If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template. + + SwitchParameter + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + + Out + + Filename to write to, optionally including full path. + + String + + + Folder + + Folder to process. If not specified the current folder will be used. + + String + + + TargetFolder + + Target folder to provision to files to. If not specified, the current folder name will be used. + + String + + + Schema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AsIncludeFile + + If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template. + + SwitchParameter + + SwitchParameter + + + + + ContentType + + An optional content type to use. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + Encoding + + The encoding type of the XML file, Unicode is default + + Encoding + + Encoding + + + + + Folder + + Folder to process. If not specified the current folder will be used. + + String + + String + + + + + Force + + Overwrites the output file if it exists. + + SwitchParameter + + SwitchParameter + + + + + Match + + Optional wildcard pattern to match filenames against. If empty all files will be included. + + String + + String + + + + + Out + + Filename to write to, optionally including full path. + + String + + String + + + + + Properties + + Additional properties to set for every file entry in the generated template. + + Hashtable + + Hashtable + + + + + Schema + + The schema of the output to use, defaults to the latest schema + + XMLPnPSchemaVersion + + XMLPnPSchemaVersion + + + + + TargetFolder + + Target folder to provision to files to. If not specified, the current folder name will be used. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml + + Creates an empty provisioning template, and includes all files in the current folder. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp + + Creates an empty provisioning template, and includes all files in the c:\temp folder. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js + + Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" + + Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -ContentType "Test Content Type" + + Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add a property to the item for the content type. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -Properties @{"Title" = "Test Title"; "Category"="Test Category"} + + Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add the specified properties to the file entries. + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.pnp + + Creates an empty provisioning template as a pnp package file, and includes all files in the current folder + + + + + + + + + + ------------------EXAMPLE 8--------------------- + + + + PS:> New-PnPProvisioningTemplateFromFolder -Out template.pnp -Folder c:\temp + + Creates an empty provisioning template as a pnp package file, and includes all files in the c:\temp folder + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Encoding: + https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx + + + + + + New-PnPSite + + * Supported in: SharePoint Online. + +BETA: This cmdlet is using early release APIs. Notice that functionality and parameters can change. Creates a new site collection + + + + + New + PnPSite + + + + The New-PnPSite cmdlet creates a new site collection for the current tenant. Currently only 'modern' sites like Communication Site and the Modern Team Site are supported. If you want to create a classic site, use New-PnPTenantSite. + + + + New-PnPSite + + Type + + @Specifies with type of site to create. + + SiteType + + + Title + + Specifies the title of the new site collection + + String + + + Url + + Specifies the full url of the new site collection + + String + + + Description + + Specifies the description of the new site collection + + String + + + Classification + + Specifies the classification of the new site collection + + String + + + AllowFileSharingForGuestUsers + + Specifies if guest users can share files in the new site collection + + SwitchParameter + + + SiteDesign + + Specifies the site design of the new site collection. Defaults to 'Topic' + + CommunicationSiteDesign + + + Lcid + + Specifies the language of the new site collection. Defaults to the current language of the web connected to. + + UInt32 + + + 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. + + SPOnlineConnection + + + + New-PnPSite + + Type + + @Specifies with type of site to create. + + SiteType + + + Title + + Specifies the title of the new site collection + + String + + + Alias + + Specifies the alias of the new site collection + + String + + + Description + + Specifies the description of the new site collection + + String + + + Classification + + Specifies the classification of the new site collection + + String + + + IsPublic + + Specifies if new site collection is public. Defaults to false. + + String + + + 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. + + SPOnlineConnection + + + + New-PnPSite + + Type + + @Specifies with type of site to create. + + SiteType + + + Title + + Specifies the title of the new site collection + + String + + + Url + + Specifies the full url of the new site collection + + String + + + SiteDesignId + + Specifies the site design id to use for the new site collection. If specified will override SiteDesign + + GuidPipeBind + + + Description + + Specifies the description of the new site collection + + String + + + Classification + + Specifies the classification of the new site collection + + String + + + AllowFileSharingForGuestUsers + + Specifies if guest users can share files in the new site collection + + SwitchParameter + + + Lcid + + Specifies the language of the new site collection. Defaults to the current language of the web connected to. + + UInt32 + + + 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. + + SPOnlineConnection + + + + + + Alias + + Specifies the alias of the new site collection + + String + + String + + + + + AllowFileSharingForGuestUsers + + Specifies if guest users can share files in the new site collection + + SwitchParameter + + SwitchParameter + + + + + Classification + + Specifies the classification of the new site collection + + String + + String + + + + + Description + + Specifies the description of the new site collection + + String + + String + + + + + IsPublic + + Specifies if new site collection is public. Defaults to false. + + String + + String + + + + + Lcid + + Specifies the language of the new site collection. Defaults to the current language of the web connected to. + + UInt32 + + UInt32 + + + + + SiteDesign + + Specifies the site design of the new site collection. Defaults to 'Topic' + + CommunicationSiteDesign + + CommunicationSiteDesign + + + + + SiteDesignId + + Specifies the site design id to use for the new site collection. If specified will override SiteDesign + + GuidPipeBind + + GuidPipeBind + + + + + Title + + Specifies the title of the new site collection + + String + + String + + + + + Type + + @Specifies with type of site to create. + + SiteType + + SiteType + + + + + Url + + Specifies the full url of the new site collection + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + System.String + + + Returns the url of the newly created site collection + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso + + This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesign Showcase + + This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the 'Showcase' design for the site. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesignId ae2349d5-97d6-4440-94d1-6516b72449ac + + This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the specified custom site design for the site. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Classification "HBI" + + This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. The classification for the site will be set to "HBI" + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -AllowFileSharingForGuestUsers + + This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. File sharing for guest users will be enabled. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> New-PnPSite -Type TeamSite -Title Contoso -Alias contoso + + This will create a new Modern Team Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. + + + + + + + + + + ------------------EXAMPLE 7--------------------- + + + + PS:> New-PnPSite -Type TeamSite -Title Contoso -Alias contoso -IsPublic + + This will create a new Modern Team Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' and sets the site to public. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPTenantSite + + Creates a new site collection for the current tenant + + + + + New + PnPTenantSite + + + + The New-PnPTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint +Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx + + + + New-PnPTenantSite + + Title + + Specifies the title of the new site collection + + String + + + Url + + Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams. + + String + + + Owner + + Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group. + + String + + + TimeZone + + Use Get-PnPTimeZoneId to retrieve possible timezone values + + Int32 + + + Description + + Specifies the description of the new site collection + + String + + + Lcid + + Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx + + UInt32 + + + Template + + Specifies the site collection template type. Use the Get-PnPWebTemplate cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-PnPWebTemplates cmdlet. + + String + + + ResourceQuota + + Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. + + Double + + + ResourceQuotaWarningLevel + + Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter + + Double + + + StorageQuota + + Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. + + Int64 + + + StorageQuotaWarningLevel + + Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter + + Int64 + + + RemoveDeletedSite + + Specifies if any existing site with the same URL should be removed from the recycle bin + + SwitchParameter + + + Wait + + + + SwitchParameter + + + Force + + Do not ask for confirmation. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Description + + Specifies the description of the new site collection + + String + + String + + + + + Force + + Do not ask for confirmation. + + SwitchParameter + + SwitchParameter + + + + + Lcid + + Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx + + UInt32 + + UInt32 + + + + + Owner + + Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group. + + String + + String + + + + + RemoveDeletedSite + + Specifies if any existing site with the same URL should be removed from the recycle bin + + SwitchParameter + + SwitchParameter + + + + + ResourceQuota + + Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. + + Double + + Double + + + + + ResourceQuotaWarningLevel + + Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter + + Double + + Double + + + + + StorageQuota + + Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. + + Int64 + + Int64 + + + + + StorageQuotaWarningLevel + + Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter + + Int64 + + Int64 + + + + + Template + + Specifies the site collection template type. Use the Get-PnPWebTemplate cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-PnPWebTemplates cmdlet. + + String + + String + + + + + TimeZone + + Use Get-PnPTimeZoneId to retrieve possible timezone values + + Int32 + + Int32 + + + + + Title + + Specifies the title of the new site collection + + String + + String + + + + + Url + + Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams. + + String + + String + + + + + Wait + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner user@example.org -TimeZone 4 -Template STS#0 + + This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00',the owner 'user@example.org' and the template used will be STS#0, a TeamSite + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> New-PnPTenantSite -Title Contoso -Url /sites/contososite -Owner user@example.org -TimeZone 4 -Template STS#0 + + This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contososite' of which the base part will be picked up from your current connection, the timezone 'UTC+01:00', the owner 'user@example.org' and the template used will be STS#0, a TeamSite + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Locale IDs: + http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911 + + + Resource Usage Limits on Sandboxed Solutions in SharePoint 2010: + http://msdn.microsoft.com/en-us/library/gg615462.aspx. + + + Creating on-premises site collections using CSOM: + http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx + + + + + + New-PnPTerm + + Creates a taxonomy term + + + + + New + PnPTerm + + + + + New-PnPTerm + + Name + + The name of the term. + + String + + + TermGroup + + The termgroup to create the term in. + + Id, Title or TermGroup + + + TermSet + + The termset to add the term to. + + Id, Title or TaxonomyItem + + + Id + + The Id to use for the term; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + + Lcid + + The locale id to use for the term. Defaults to the current locale id. + + Int32 + + + Description + + Descriptive text to help users understand the intended use of this term. + + String + + + CustomProperties + + Custom Properties + + Hashtable + + + LocalCustomProperties + + Custom Properties + + Hashtable + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + + 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. + + SPOnlineConnection + + + + + + CustomProperties + + Custom Properties + + Hashtable + + Hashtable + + + + + Description + + Descriptive text to help users understand the intended use of this term. + + String + + String + + + + + Id + + The Id to use for the term; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + Guid + + + + + Lcid + + The locale id to use for the term. Defaults to the current locale id. + + Int32 + + Int32 + + + + + LocalCustomProperties + + Custom Properties + + Hashtable + + Hashtable + + + + + Name + + The name of the term. + + String + + String + + + + + TermGroup + + The termgroup to create the term in. + + Id, Title or TermGroup + + Id, Title or TermGroup + + + + + TermSet + + The termset to add the term to. + + Id, Title or TaxonomyItem + + Id, Title or TaxonomyItem + + + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.Term + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance" + + Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPTermGroup + + Creates a taxonomy term group + + + + + New + PnPTermGroup + + + + + New-PnPTermGroup + + Name + + Name of the taxonomy term group to create. + + String + + + Id + + GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + + Description + + Description to use for the term group. + + String + + + TermStore + + Term store to add the group to; if not specified the default term store is used. + + Id, Name or Object + + + 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. + + SPOnlineConnection + + + + + + Description + + Description to use for the term group. + + String + + String + + + + + Id + + GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + Guid + + + + + Name + + Name of the taxonomy term group to create. + + String + + String + + + + + TermStore + + Term store to add the group to; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TermGroup + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPTermGroup -GroupName "Countries" + + Creates a new taxonomy term group named "Countries" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPTermSet + + Creates a taxonomy term set + + + + + New + PnPTermSet + + + + + New-PnPTermSet + + Name + + The name of the termset. + + String + + + TermGroup + + Name, id or actualy termgroup to create the termset in. + + Id, Title or TermGroup + + + Id + + The Id to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + + Lcid + + The locale id to use for the term set. Defaults to the current locale id. + + Int32 + + + Contact + + An e-mail address for term suggestion and feedback. If left blank the suggestion feature will be disabled. + + String + + + Description + + Descriptive text to help users understand the intended use of this term set. + + String + + + IsOpenForTermCreation + + When a term set is closed, only metadata managers can add terms to this term set. When it is open, users can add terms from a tagging application. Not specifying this switch will make the term set closed. + + SwitchParameter + + + IsNotAvailableForTagging + + By default a term set is available to be used by end users and content editors of sites consuming this term set. Specify this switch to turn this off + + SwitchParameter + + + Owner + + The primary user or group of this term set. + + String + + + StakeHolders + + People and groups in the organization that should be notified before major changes are made to the term set. You can enter multiple users or groups. + + String[] + + + CustomProperties + + + + Hashtable + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + + 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. + + SPOnlineConnection + + + + + + Contact + + An e-mail address for term suggestion and feedback. If left blank the suggestion feature will be disabled. + + String + + String + + + + + CustomProperties + + + + Hashtable + + Hashtable + + + + + Description + + Descriptive text to help users understand the intended use of this term set. + + String + + String + + + + + Id + + The Id to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used. + + Guid + + Guid + + + + + IsNotAvailableForTagging + + By default a term set is available to be used by end users and content editors of sites consuming this term set. Specify this switch to turn this off + + SwitchParameter + + SwitchParameter + + + + + IsOpenForTermCreation + + When a term set is closed, only metadata managers can add terms to this term set. When it is open, users can add terms from a tagging application. Not specifying this switch will make the term set closed. + + SwitchParameter + + SwitchParameter + + + + + Lcid + + The locale id to use for the term set. Defaults to the current locale id. + + Int32 + + Int32 + + + + + Name + + The name of the termset. + + String + + String + + + + + Owner + + The primary user or group of this term set. + + String + + String + + + + + StakeHolders + + People and groups in the organization that should be notified before major changes are made to the term set. You can enter multiple users or groups. + + String[] + + String[] + + + + + TermGroup + + Name, id or actualy termgroup to create the termset in. + + Id, Title or TermGroup + + Id, Title or TermGroup + + + + + TermStore + + Term store to check; if not specified the default term store is used. + + Id, Name or Object + + Id, Name or Object + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Taxonomy.TermSet + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPTermSet -Name "Department" -TermGroup "Corporate" + + Creates a new termset named "Department" in the group named "Corporate" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPUser + + Adds a user to the built-in Site User Info List and returns a user object + + + + + New + PnPUser + + + + + New-PnPUser + + LoginName + + The users login name (user@company.com) + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + LoginName + + The users login name (user@company.com) + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.User + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPUser -LoginName user@company.com + + Adds a new user with the login user@company.com to the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + New-PnPWeb + + Creates a new subweb under the current web + + + + + New + PnPWeb + + + + + New-PnPWeb + + Title + + The title of the new web + + String + + + Url + + The URL of the new web + + String + + + Template + + The site definition template to use for the new web, e.g. STS#0. Use Get-PnPWebTemplates to fetch a list of available templates + + String + + + Description + + The description of the new web + + String + + + Locale + + The language id of the new web. default = 1033 for English + + Int32 + + + BreakInheritance + + By default the subweb will inherit its security from its parent, specify this switch to break this inheritance + + SwitchParameter + + + InheritNavigation + + Specifies whether the site inherits navigation. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + BreakInheritance + + By default the subweb will inherit its security from its parent, specify this switch to break this inheritance + + SwitchParameter + + SwitchParameter + + + + + Description + + The description of the new web + + String + + String + + + + + InheritNavigation + + Specifies whether the site inherits navigation. + + SwitchParameter + + SwitchParameter + + + + + Locale + + The language id of the new web. default = 1033 for English + + Int32 + + Int32 + + + + + Template + + The site definition template to use for the new web, e.g. STS#0. Use Get-PnPWebTemplates to fetch a list of available templates + + String + + String + + + + + Title + + The title of the new web + + String + + String + + + + + Url + + The URL of the new web + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Web + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> New-PnPWeb -Title "Project A Web" -Url projectA -Description "Information about Project A" -Locale 1033 -Template "STS#0" + + Creates a new subweb under the current web with URL projectA + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Publish-PnPApp + + * Supported in: SharePoint Online. + +Publishes/Deploys/Trusts an available app in the app catalog + + + + + Publish + PnPApp + + + + + Publish-PnPApp + + Identity + + Specifies the Id of the app + + AppMetadataPipeBind + + + SkipFeatureDeployment + + + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of the app + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + SkipFeatureDeployment + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Publish-PnPApp + + This will deploy/trust an app into the app catalog. Notice that the app needs to be available in the app catalog + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Read-PnPProvisioningTemplate + + Loads/Reads a PnP file from the file system + + + + + Read + PnPProvisioningTemplate + + + + + Read-PnPProvisioningTemplate + + Path + + Filename to read from, optionally including full path. + + String + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + + + + + Path + + Filename to read from, optionally including full path. + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while loading the template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Read-PnPProvisioningTemplate -Path template.pnp + + Loads a PnP file from the file systems + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Read-PnPProvisioningTemplate -Path template.pnp -TemplateProviderExtensions $extensions + + Loads a PnP file from the file systems using some custom template provider extenions while loading the file. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Register-PnPHubSite + + * Supported in: SharePoint Online. + +Registers a site as a hubsite + + + + + Register + PnPHubSite + + + + Registers a site as a hubsite + + + + Register-PnPHubSite + + Site + + The site to register as a hubsite + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + Site + + The site to register as a hubsite + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Register-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite + + This example registers the specified site as a hubsite + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPApp + + * Supported in: SharePoint Online. + +Removes an app from the app catalog + + + + + Remove + PnPApp + + + + + Remove-PnPApp + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will remove the specified app from the app catalog + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPClientSideComponent + + * Supported in: SharePoint Online. + +Removes a Client-Side component from a page + + + + + Remove + PnPClientSideComponent + + + + + Remove-PnPClientSideComponent + + InstanceId + + The instance id of the component + + GuidPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Force + + If specified you will not receive the confirmation question + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + If specified you will not receive the confirmation question + + SwitchParameter + + SwitchParameter + + + + + InstanceId + + The instance id of the component + + GuidPipeBind + + GuidPipeBind + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 + + Removes the control specified from the page. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPClientSidePage + + * Supported in: SharePoint Online. + +Removes a Client-Side Page + + + + + Remove + PnPClientSidePage + + + + + Remove-PnPClientSidePage + + Identity + + The name of the page + + ClientSidePagePipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPClientSidePage -Identity "MyPage" + + Removes the Client-Side page named 'MyPage.aspx' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPClientSidePage $page + + Removes the specified Client-Side page which is contained in the $page variable. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPContentType + + Removes a content type from a web + + + + + Remove + PnPContentType + + + + + Remove-PnPContentType + + Identity + + The name or ID of the content type to remove + + ContentTypePipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The name or ID of the content type to remove + + ContentTypePipeBind + + ContentTypePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPContentType -Identity "Project Document" + + This will remove a content type called "Project Document" from the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPContentType -Identity "Project Document" -Force + + This will remove a content type called "Project Document" from the current web with force + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPContentTypeFromDocumentSet + + Removes a content type from a document set + + + + + Remove + PnPContentTypeFromDocumentSet + + + + + Remove-PnPContentTypeFromDocumentSet + + ContentType + + The content type to remove. Either specify name, an id, or a content type object. + + ContentTypePipeBind + + + DocumentSet + + The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The content type to remove. Either specify name, an id, or a content type object. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + DocumentSet + + The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + DocumentSetPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPContentTypeFromDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" + + This will remove the content type called 'Test CT' from the document set called ''Test Document Set' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPContentTypeFromDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B + + This will remove the content type with ID '0x0101001F1CEFF1D4126E4CAD10F00B6137E969' from the document set with ID '0x0120D520005DB65D094035A241BAC9AF083F825F3B' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPContentTypeFromList + + Removes a content type from a list + + + + + Remove + PnPContentTypeFromList + + + + + Remove-PnPContentTypeFromList + + List + + The name of the list, its ID or an actual list object from where the content type needs to be removed from + + ListPipeBind + + + ContentType + + The name of a content type, its ID or an actual content type object that needs to be removed from the specified list. + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The name of a content type, its ID or an actual content type object that needs to be removed from the specified list. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + List + + The name of the list, its ID or an actual list object from where the content type needs to be removed from + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPContentTypeFromList -List "Documents" -ContentType "Project Document" + + This will remove a content type called "Project Document" from the "Documents" list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPCustomAction + + Removes a custom action + + + + + Remove + PnPCustomAction + + + + + Remove-PnPCustomAction + + Scope + + Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. + + CustomActionScope + + + Force + + Use the -Force flag to bypass the confirmation question + + SwitchParameter + + + Identity + + The id or name of the CustomAction that needs to be removed or a CustomAction instance itself + + UserCustomActionPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Use the -Force flag to bypass the confirmation question + + SwitchParameter + + SwitchParameter + + + + + Identity + + The id or name of the CustomAction that needs to be removed or a CustomAction instance itself + + UserCustomActionPipeBind + + UserCustomActionPipeBind + + + + + Scope + + Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. + + CustomActionScope + + CustomActionScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 + + Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web + + Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' from the current web. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Force + + Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' without asking for confirmation. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPCustomAction -Scope All | ? Location -eq ScriptLink | Remove-PnPCustomAction + + Removes all custom actions that are ScriptLinks + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPIndexedProperty + + Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore. + + + + + Remove + PnPIndexedProperty + + + + + Remove-PnPIndexedProperty + + Key + + Key of the property bag value to be removed from indexing + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Key + + Key of the property bag value to be removed from indexing + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPIndexedProperty -key "MyIndexProperty" + + Removes the Indexed property "MyIndexProperty" from the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPEventReceiver + + Remove an eventreceiver + + + + + Remove + PnPEventReceiver + + + + Removes/unregisters a specific eventreceiver + + + + Remove-PnPEventReceiver + + Identity + + The Guid of the event receiver on the list + + EventReceiverPipeBind + + + List + + The list object from where to remove the event receiver object + + ListPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question + + SwitchParameter + + SwitchParameter + + + + + Identity + + The Guid of the event receiver on the list + + EventReceiverPipeBind + + EventReceiverPipeBind + + + + + List + + The list object from where to remove the event receiver object + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 + + This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPEventReceiver -List ProjectList -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 + + This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the "ProjectList" list + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPEventReceiver -List ProjectList -Identity MyReceiver + + This will remove the event receiver with ReceiverName "MyReceiver" from the "ProjectList" list + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Remove-PnPEventReceiver -List ProjectList + + This will remove all event receivers from the "ProjectList" list + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Remove-PnPEventReceiver + + This will remove all event receivers from the current site + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPEventReceiver | ? ReceiverUrl -Like "*azurewebsites.net*" | Remove-PnPEventReceiver + + This will remove all event receivers from the current site which are pointing to a service hosted on Azure Websites + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPField + + Removes a field from a list or a site + + + + + Remove + PnPField + + + + + Remove-PnPField + + Identity + + The field object or name to remove + + FieldPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + List + + The list object or name where to remove the field from + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The field object or name to remove + + FieldPipeBind + + FieldPipeBind + + + + + List + + The list object or name where to remove the field from + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPField -Identity "Speakers" + + Removes the speakers field from the site columns + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPField -List "Demo list" -Identity "Speakers" + + Removes the speakers field from the list Demo list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPFieldFromContentType + + Removes a site column from a content type + + + + + Remove + PnPFieldFromContentType + + + + + Remove-PnPFieldFromContentType + + Field + + The field to remove + + FieldPipeBind + + + ContentType + + The content type where the field is to be removed from + + ContentTypePipeBind + + + DoNotUpdateChildren + + If specified, inherited content types will not be updated + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The content type where the field is to be removed from + + ContentTypePipeBind + + ContentTypePipeBind + + + + + DoNotUpdateChildren + + If specified, inherited content types will not be updated + + SwitchParameter + + SwitchParameter + + + + + Field + + The field to remove + + FieldPipeBind + + FieldPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document" + + This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document" -DoNotUpdateChildren + + This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document". It will not update content types that inherit from the "Project Document" content type. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPFile + + Removes a file. + + + + + Remove + PnPFile + + + + + Remove-PnPFile + + ServerRelativeUrl + + Server relative URL to the file + + String + + + Recycle + + + + SwitchParameter + + + Force + + + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Remove-PnPFile + + SiteRelativeUrl + + Site relative URL to the file + + String + + + Recycle + + + + SwitchParameter + + + Force + + + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + Recycle + + + + SwitchParameter + + SwitchParameter + + + + + ServerRelativeUrl + + Server relative URL to the file + + String + + String + + + + + SiteRelativeUrl + + Site relative URL to the file + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Remove-PnPFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor + + Removes the file company.spcolor + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor + + Removes the file company.spcolor + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -Recycle + + Removes the file company.spcolor and saves it to the Recycle Bin + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPFileFromProvisioningTemplate + + Removes a file from a PnP Provisioning Template + + + + + Remove + PnPFileFromProvisioningTemplate + + + + + Remove-PnPFileFromProvisioningTemplate + + Path + + Filename to read the template from, optionally including full path. + + String + + + FilePath + + The relative File Path of the file to remove from the in-memory template + + String + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while saving the template. + + ITemplateProviderExtension[] + + + + + + FilePath + + The relative File Path of the file to remove from the in-memory template + + String + + String + + + + + Path + + Filename to read the template from, optionally including full path. + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while saving the template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPFileFromProvisioningTemplate -Path template.pnp -FilePath filePath + + Removes a file from an in-memory PnP Provisioning Template + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPFolder + + Deletes a folder within a parent folder + + + + + Remove + PnPFolder + + + + + Remove-PnPFolder + + Name + + The folder name + + String + + + Folder + + The parent folder in the site + + String + + + Recycle + + + + SwitchParameter + + + Force + + + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + The parent folder in the site + + String + + String + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + Name + + The folder name + + String + + String + + + + + Recycle + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage + + Removes the folder 'NewFolder' from '_catalogsmasterpage' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -Recycle + + Removes the folder 'NewFolder' from '_catalogsmasterpage' and is saved in the Recycle Bin + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPGroup + + Removes a group from a web. + + + + + Remove + PnPGroup + + + + + Remove-PnPGroup + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + Identity + + A group object, an ID or a name of a group to remove + + GroupPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + A group object, an ID or a name of a group to remove + + GroupPipeBind + + GroupPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPGroup -Identity "My Users" + + Removes the group "My Users" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPHubSiteAssociation + + * Supported in: SharePoint Online. + +Disconnects a site from a hubsite. + + + + + Remove + PnPHubSiteAssociation + + + + Disconnects an site from a hubsite + + + + Remove-PnPHubSiteAssociation + + Site + + The site to disconnect from its hubsite + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + Site + + The site to disconnect from its hubsite + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite + + This example adds the specified site to the hubsite. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPJavaScriptLink + + Removes a JavaScript link or block from a web or sitecollection + + + + + Remove + PnPJavaScriptLink + + + + + Remove-PnPJavaScriptLink + + Force + + Use the -Force flag to bypass the confirmation question + + SwitchParameter + + + Scope + + Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. + + CustomActionScope + + + Identity + + Name or id of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links. + + UserCustomActionPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Use the -Force flag to bypass the confirmation question + + SwitchParameter + + SwitchParameter + + + + + Identity + + Name or id of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links. + + UserCustomActionPipeBind + + UserCustomActionPipeBind + + + + + Scope + + Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection. + + CustomActionScope + + CustomActionScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPJavaScriptLink -Identity jQuery + + Removes the injected JavaScript file with the name jQuery from the current web after confirmation + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPJavaScriptLink -Identity jQuery -Scope Site + + Removes the injected JavaScript file with the name jQuery from the current site collection after confirmation + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPJavaScriptLink -Identity jQuery -Scope Site -Confirm:$false + + Removes the injected JavaScript file with the name jQuery from the current site collection and will not ask for confirmation + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Remove-PnPJavaScriptLink -Scope Site + + Removes all the injected JavaScript files from the current site collection after confirmation for each of them + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Remove-PnPJavaScriptLink -Identity faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e -Scope All + + Removes the injected JavaScript file with id faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e from both the Web and Site scopes + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Get-PnPJavaScriptLink -Scope All | ? Sequence -gt 1000 | Remove-PnPJavaScriptLink + + Removes all the injected JavaScript files from both the Web and Site scope that have a sequence number higher than 1000 + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPList + + Deletes a list + + + + + Remove + PnPList + + + + + Remove-PnPList + + Identity + + The ID or Title of the list. + + ListPipeBind + + + Recycle + + + + SwitchParameter + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID or Title of the list. + + ListPipeBind + + ListPipeBind + + + + + Recycle + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPList -Identity Announcements + + Removes the list named 'Announcements'. Asks for confirmation. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPList -Identity Announcements -Force + + Removes the list named 'Announcements' without asking for confirmation. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPList -Title Announcements -Recycle + + Removes the list named 'Announcements' and saves to the Recycle Bin + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPListItem + + Deletes an item from a list + + + + + Remove + PnPListItem + + + + + Remove-PnPListItem + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + Recycle + + + + SwitchParameter + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + Recycle + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPListItem -List "Demo List" -Identity "1" -Force + + Removes the listitem with id "1" from the "Demo List" list. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPListItem -List "Demo List" -Identity "1" -Force -Recycle + + Removes the listitem with id "1" from the "Demo List" list and saves it in the Recycle Bin. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPNavigationNode + + Removes a menu item from either the quicklaunch or top navigation + + + + + Remove + PnPNavigationNode + + + + + Remove-PnPNavigationNode + + Identity + + The Id or node object to delete + + NavigationNodePipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Remove-PnPNavigationNode + + All + + Specifying the All parameter will remove all the nodes from specifed Location. + + SwitchParameter + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + All + + Specifying the All parameter will remove all the nodes from specifed Location. + + SwitchParameter + + SwitchParameter + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The Id or node object to delete + + NavigationNodePipeBind + + NavigationNodePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPNavigationNode -Identity 1032 + + Removes the navigation node with the specified id + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $nodes = Get-PnPNavigationNode -QuickLaunch +PS:>$nodes | Select-Object -First 1 | Remove-PnPNavigationNode -Force + + Retrieves all navigation nodes from the Quick Launch navigation, then removes the first node in the list and it will not ask for a confirmation + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPNavigationNode -Title Recent -Location QuickLaunch + + Will remove the recent navigation node from the quick launch in the current web. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Remove-PnPNavigationNode -Title Home -Location TopNavigationBar -Force + + Will remove the home navigation node from the top navigation bar without prompting for a confirmation in the current web. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Remove-PnPNavigationNode -Location QuickLaunch -All + + Will remove all the navigation nodes from the quick launch bar in the current web. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPStorageEntity + + * Supported in: SharePoint Online. + +Remove Storage Entities / Farm Properties. + + + + + Remove + PnPStorageEntity + + + + + Remove-PnPStorageEntity + + Key + + The key of the value to set. + + String + + + 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. + + SPOnlineConnection + + + + + + Key + + The key of the value to set. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPStorageEntity -Key MyKey + + Removes an existing storage entity / farm property + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPPropertyBagValue + + Removes a value from the property bag + + + + + Remove + PnPPropertyBagValue + + + + + Remove-PnPPropertyBagValue + + Key + + Key of the property bag value to be removed + + String + + + Folder + + Site relative url of the folder. See examples for use. + + String + + + Force + + + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + Site relative url of the folder. See examples for use. + + String + + String + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + Key + + Key of the property bag value to be removed + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPPropertyBagValue -Key MyKey + + This will remove the value with key MyKey from the current web property bag + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder /MyFolder + + This will remove the value with key MyKey from the folder MyFolder which is located in the root folder of the current web + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder / + + This will remove the value with key MyKey from the root folder of the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPPublishingImageRendition + + Removes an existing image rendition + + + + + Remove + PnPPublishingImageRendition + + + + + Remove-PnPPublishingImageRendition + + Identity + + The display name or id of the Image Rendition. + + ImageRenditionPipeBind + + + Force + + If provided, no confirmation will be asked to remove the Image Rendition. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be asked to remove the Image Rendition. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The display name or id of the Image Rendition. + + ImageRenditionPipeBind + + ImageRenditionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600 + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPRoleDefinition + + Remove a Role Definition from a site + + + + + Remove + PnPRoleDefinition + + + + + Remove-PnPRoleDefinition + + Identity + + The identity of the role definition, either a RoleDefinition object or a the name of roledefinition + + RoleDefinitionPipeBind + + + Force + + Do not ask for confirmation to delete the role definition + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + Do not ask for confirmation to delete the role definition + + SwitchParameter + + SwitchParameter + + + + + Identity + + The identity of the role definition, either a RoleDefinition object or a the name of roledefinition + + RoleDefinitionPipeBind + + RoleDefinitionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPRoleDefinition -Identity MyRoleDefinition + + Removes the specified Role Definition (Permission Level) from the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPTenantSite + + * Supported in: SharePoint Online. + +Removes a site collection + + + + + Remove + PnPTenantSite + + + + Removes a site collection which is listed in your tenant administration site. + + + + Remove-PnPTenantSite + + Url + + Specifies the full URL of the site collection that needs to be deleted + + String + + + SkipRecycleBin + + Do not add to the tenant scoped recycle bin when selected. + + SwitchParameter + + + Force + + Do not ask for confirmation. + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + Do not ask for confirmation. + + SwitchParameter + + SwitchParameter + + + + + SkipRecycleBin + + Do not add to the tenant scoped recycle bin when selected. + + SwitchParameter + + SwitchParameter + + + + + Url + + Specifies the full URL of the site collection that needs to be deleted + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso + + This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' and put it in the recycle bin. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin + + This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin + + This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPSiteClassification + + * Supported in: SharePoint Online. + +Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph + + + + + Remove + PnPSiteClassification + + + + + Remove-PnPSiteClassification + + Classifications + + + + String + + + Confirm + + Specifying the Confirm parameter will allow the confirmation question to be skipped + + SwitchParameter + + + + + + Classifications + + + + String + + String + + + + + Confirm + + Specifying the Confirm parameter will allow the confirmation question to be skipped + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Remove-PnPSiteClassification -Classifications "HBI" + + Removes the "HBI" site classification from the list of available values. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Remove-PnPSiteClassification -Classifications "HBI", "Top Secret" + + Removes the "HBI" site classification from the list of available values. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPSiteCollectionAdmin + + Removes one or more users as site collection administrators from the site collection in the current context + + + + + Remove + PnPSiteCollectionAdmin + + + + This command allows removing one to many users as site collection administrators from the site collection in the current context. All existing site collection administrators not included in this command will remain site collection administrator. + + + + Remove-PnPSiteCollectionAdmin + + Owners + + Specifies owner(s) to remove as site collection adminstrators. Can be both users and groups. + + UserPipeBind + + + 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. + + SPOnlineConnection + + + + + + Owners + + Specifies owner(s) to remove as site collection adminstrators. Can be both users and groups. + + UserPipeBind + + UserPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com" + + This will remove user@contoso.onmicrosoft.com as a site collection owner from the site collection in the current context + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") + + This will remove user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as site collection owners from the site collection in the current context + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPUser | ? Title -Like "*Doe" | Remove-PnPSiteCollectionAdmin + + This will remove all users with their title ending with "Doe" as site collection owners from the site collection in the current context + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Get-PnPSiteCollectionAdmin | Remove-PnPSiteCollectionAdmin + + This will remove all existing site collection administrators from the site collection in the current context + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPSiteCollectionAppCatalog + + * Supported in: SharePoint Online. + +Removes a Site Collection scoped App Catalog from a site + + + + + Remove + PnPSiteCollectionAppCatalog + + + + Notice that this will not remove the App Catalog list and its contents from the site. + + + + Remove-PnPSiteCollectionAppCatalog + + Site + + Url of the site to remove the app catalog from. + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + Site + + Url of the site to remove the app catalog from. + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" + + This will remove a SiteCollection app catalog from the specified site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPSiteDesign + + * Supported in: SharePoint Online. + +Removes a Site Design + + + + + Remove + PnPSiteDesign + + + + + Remove-PnPSiteDesign + + Identity + + The ID of the site design to remove + + TenantSiteDesignPipeBind + + + Force + + If specified you will not be asked to confirm removing the specified Site Design + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + If specified you will not be asked to confirm removing the specified Site Design + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID of the site design to remove + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Removes the specified site design + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPSiteScript + + * Supported in: SharePoint Online. + +Removes a Site Script + + + + + Remove + PnPSiteScript + + + + + Remove-PnPSiteScript + + Identity + + The ID of the Site Script to remove + + TenantSiteScriptPipeBind + + + Force + + If specified you will not be asked to confirm removing the specified Site Script + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + If specified you will not be asked to confirm removing the specified Site Script + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID of the Site Script to remove + + TenantSiteScriptPipeBind + + TenantSiteScriptPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd + + Removes the specified site script + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPStoredCredential + + Removes a credential + + + + + Remove + PnPStoredCredential + + + + Removes a stored credential from the Windows Credential Manager + + + + Remove-PnPStoredCredential + + Name + + The credential to remove + + String + + + Force + + If specified you will not be asked for confirmation + + SwitchParameter + + + + + + Force + + If specified you will not be asked for confirmation + + SwitchParameter + + SwitchParameter + + + + + Name + + The credential to remove + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPStoredCredential -Name https://tenant.sharepoint.com + + Removes the specified credential from the Windows Credential Manager + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPTaxonomyItem + + Removes a taxonomy item + + + + + Remove + PnPTaxonomyItem + + + + + Remove-PnPTaxonomyItem + + TermPath + + The path, delimited by | of the taxonomy item to remove, alike GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + + Force + + + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + TermPath + + The path, delimited by | of the taxonomy item to remove, alike GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPTenantCdnOrigin + + * Supported in: SharePoint Online. + +Removes an origin from the Public or Private content delivery network (CDN). + + + + + Remove + PnPTenantCdnOrigin + + + + Removes an origin from the Public or Private content delivery network (CDN). + +You must be a SharePoint Online global administrator to run the cmdlet. + + + + Remove-PnPTenantCdnOrigin + + OriginUrl + + The origin to remove. + + String + + + CdnType + + The cdn type to remove the origin from. + + SPOTenantCdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The cdn type to remove the origin from. + + SPOTenantCdnType + + SPOTenantCdnType + + + + + OriginUrl + + The origin to remove. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPTenantCdnOrigin -Url /sites/site/subfolder -CdnType Public + + This example removes the specified origin from the public CDN + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPTenantTheme + + * Supported in: SharePoint Online. + +Removes a theme + + + + + Remove + PnPTenantTheme + + + + Removes the specified theme from the tenant configuration + + + + Remove-PnPTenantTheme + + Identity + + The name of the theme to retrieve + + ThemePipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The name of the theme to retrieve + + ThemePipeBind + + ThemePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPTenantTheme -Name "MyCompanyTheme" + + Removes the specified theme. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPTermGroup + + Removes a taxonomy term group and all its containing termsets + + + + + Remove + PnPTermGroup + + + + + Remove-PnPTermGroup + + GroupName + + Name of the taxonomy term group to delete. + + String + + + TermStoreName + + Term store to use; if not specified the default term store is used. + + String + + + Force + + + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + + + SwitchParameter + + SwitchParameter + + + + + GroupName + + Name of the taxonomy term group to delete. + + String + + String + + + + + TermStoreName + + Term store to use; if not specified the default term store is used. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPUnifiedGroup + + * Supported in: SharePoint Online. + +Removes one Office 365 Group (aka Unified Group) or a list of Office 365 Groups + + + + + Remove + PnPUnifiedGroup + + + + + Remove-PnPUnifiedGroup + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + + + + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + UnifiedGroupPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPUnifiedGroup -Identity $groupId + + Removes an Office 365 Groups based on its ID + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPUnifiedGroup -Identity $group + + Removes the provided Office 365 Groups + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPUser + + Removes a specific user from the site collection User Information List + + + + + Remove + PnPUser + + + + This command will allow the removal of a specific user from the User Information List + + + + Remove-PnPUser + + Identity + + User ID or login name + + UserPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question + + SwitchParameter + + + Confirm + + Specifying the Confirm parameter will allow the confirmation question to be skipped + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Confirm + + Specifying the Confirm parameter will allow the confirmation question to be skipped + + SwitchParameter + + SwitchParameter + + + + + Force + + Specifying the Force parameter will skip the confirmation question + + SwitchParameter + + SwitchParameter + + + + + Identity + + User ID or login name + + UserPipeBind + + UserPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.User + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPUser -Identity 23 + + Remove the user with Id 23 from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com + + Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com" | Remove-PnPUser + + Remove the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -Confirm:$false + + Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection without asking to confirm the removal first + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPUserFromGroup + + Removes a user from a group + + + + + Remove + PnPUserFromGroup + + + + + Remove-PnPUserFromGroup + + LoginName + + A valid login name of a user (user@company.com) + + String + + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + GroupPipeBind + + + + + LoginName + + A valid login name of a user (user@company.com) + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPUserFromGroup -LoginName user@company.com -GroupName 'Marketing Site Members' + + Removes the user user@company.com from the Group 'Marketing Site Members' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPView + + Deletes a view from a list + + + + + Remove + PnPView + + + + + Remove-PnPView + + Identity + + The ID or Title of the view. + + ViewPipeBind + + + List + + The ID or Url of the list. + + ListPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The ID or Title of the view. + + ViewPipeBind + + ViewPipeBind + + + + + List + + The ID or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPView -List "Demo List" -Identity "All Items" + + Removes the view with title "All Items" from the "Demo List" list. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWeb + + Removes a subweb in the current web + + + + + Remove + PnPWeb + + + + + Remove-PnPWeb + + Url + + The site relative url of the web, e.g. 'Subweb1' + + String + + + Force + + Do not ask for confirmation to delete the subweb + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Remove-PnPWeb + + Identity + + Identity/Id/Web object to delete + + WebPipeBind + + + Force + + Do not ask for confirmation to delete the subweb + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Do not ask for confirmation to delete the subweb + + SwitchParameter + + SwitchParameter + + + + + Identity + + Identity/Id/Web object to delete + + WebPipeBind + + WebPipeBind + + + + + Url + + The site relative url of the web, e.g. 'Subweb1' + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWeb -Url projectA + + Remove a web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPWeb -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 + + Remove a web specified by its ID + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Get-PnPSubWebs | Remove-PnPWeb -Force + + Remove all subwebs and do not ask for confirmation + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWebhookSubscription + + * Supported in: SharePoint Online. + +Removes a Webhook subscription from the resource + + + + + Remove + PnPWebhookSubscription + + + + + Remove-PnPWebhookSubscription + + Identity + + The identity of the Webhook subscription to remove + + WebhookSubscriptionPipeBind + + + List + + The list object or name which the Webhook subscription will be removed from + + ListPipeBind + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The identity of the Webhook subscription to remove + + WebhookSubscriptionPipeBind + + WebhookSubscriptionPipeBind + + + + + List + + The list object or name which the Webhook subscription will be removed from + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.WebhookSubscription + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWebhookSubscription -List MyList -Identity ea1533a8-ff03-415b-a7b6-517ee50db8b6 + + Removes the Webhook subscription with the specified id from the list MyList + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList +PS:> Remove-PnPWebhookSubscription -Identity $subscriptions[0] -List MyList + + Removes the first Webhook subscription from the list MyList + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList +PS:> $subscriptions[0] | Remove-PnPWebhookSubscription -List MyList + + Removes the first Webhook subscription from the list MyList + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWebPart + + Removes a webpart from a page + + + + + Remove + PnPWebPart + + + + + Remove-PnPWebPart + + Identity + + The Guid of the webpart + + GuidPipeBind + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Remove-PnPWebPart + + Title + + The name of the webpart + + String + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Guid of the webpart + + GuidPipeBind + + GuidPipeBind + + + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + String + + + + + Title + + The name of the webpart + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 + + This will remove the webpart as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Remove-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Name MyWebpart + + This will remove the webpart as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWikiPage + + Removes a wiki page + + + + + Remove + PnPWikiPage + + + + + Remove-PnPWikiPage + + ServerRelativePageUrl + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Remove-PnPWikiPage + + SiteRelativePageUrl + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ServerRelativePageUrl + + + + String + + String + + + + + SiteRelativePageUrl + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWikiPage -PageUrl '/pages/wikipage.aspx' + + Removes the page '/pages/wikipage.aspx' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWorkflowDefinition + + Removes a workflow definition + + + + + Remove + PnPWorkflowDefinition + + + + + Remove-PnPWorkflowDefinition + + Identity + + The definition to remove + + WorkflowDefinitionPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The definition to remove + + WorkflowDefinitionPipeBind + + WorkflowDefinitionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWorkflowDefinition -Identity $wfDef + + Removes the workflow, retrieved by Get-PnPWorkflowDefinition, from the site. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWorkflowDefinition -Name MyWorkflow | Remove-PnPWorkflowDefinition + + Get the workflow MyWorkFlow and remove from the site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Remove-PnPWorkflowSubscription + + Remove workflow subscription + + + + + Remove + PnPWorkflowSubscription + + + + Removes a previously registered workflow subscription + + + + Remove-PnPWorkflowSubscription + + Identity + + The subscription to remove + + WorkflowSubscriptionPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The subscription to remove + + WorkflowSubscriptionPipeBind + + WorkflowSubscriptionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Remove-PnPWorkflowSubscription -identity $wfSub + + Removes the workflowsubscription, retrieved by Get-PnPWorkflowSubscription. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPWorkflowSubscription -Name MyWorkflow | Remove-PnPWorkflowSubscription + + Get the workflowSubscription MyWorkFlow and remove it. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Rename-PnPFile + + Renames a file in its current location + + + + + Rename + PnPFile + + + + + Rename-PnPFile + + ServerRelativeUrl + + Server relative Url specifying the file to rename. Must include the file name. + + String + + + TargetFileName + + File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location. + + String + + + OverwriteIfAlreadyExists + + If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If ommitted, the rename operation will be canceled if a file already exists with the TargetFileName file name. + + SwitchParameter + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Rename-PnPFile + + SiteRelativeUrl + + Site relative Url specifying the file to rename. Must include the file name. + + String + + + TargetFileName + + File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location. + + String + + + OverwriteIfAlreadyExists + + If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If ommitted, the rename operation will be canceled if a file already exists with the TargetFileName file name. + + SwitchParameter + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be requested and the action will be performed + + SwitchParameter + + SwitchParameter + + + + + OverwriteIfAlreadyExists + + If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If ommitted, the rename operation will be canceled if a file already exists with the TargetFileName file name. + + SwitchParameter + + SwitchParameter + + + + + ServerRelativeUrl + + Server relative Url specifying the file to rename. Must include the file name. + + String + + String + + + + + SiteRelativeUrl + + Site relative Url specifying the file to rename. Must include the file name. + + String + + String + + + + + TargetFileName + + File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx + + Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.docx. If a file named mycompany.aspx already exists, it won't perform the rename. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:>Rename-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetFileName mycompany.docx + + Renames a file named company.docx located in the document library called Documents located in the current site to mycompany.aspx. If a file named mycompany.aspx already exists, it won't perform the rename. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx -OverwriteIfAlreadyExists + + Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.aspx. If a file named mycompany.aspx already exists, it will still perform the rename and replace the original mycompany.aspx file. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Rename-PnPFolder + + Renames a folder + + + + + Rename + PnPFolder + + + + + Rename-PnPFolder + + Folder + + The folder to rename + + String + + + TargetFolderName + + The new folder name + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + The folder to rename + + String + + String + + + + + TargetFolderName + + The new folder name + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Rename-PnPFolder -Folder Documents/Reports -TargetFolderName 'Archived Reports' + + This will rename the folder Reports in the Documents library to 'Archived Reports' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Request-PnPReIndexList + + Marks the list for full indexing during the next incremental crawl + + + + + Request + PnPReIndexList + + + + + Request-PnPReIndexList + + Identity + + The ID, Title or Url of the list. + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Request-PnPReIndexList -Identity "Demo List" + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Request-PnPReIndexWeb + + Marks the web for full indexing during the next incremental crawl + + + + + Request + PnPReIndexWeb + + + + + Request-PnPReIndexWeb + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Resolve-PnPFolder + + Returns a folder from a given site relative path, and will create it if it does not exist. + + + + + Resolve + PnPFolder + + + + Returns a folder from a given site relative path, and will create it if it does not exist. If you do not want the folder to be created, for instance just to test if a folder exists, use Get-PnPFolder + + + + Resolve-PnPFolder + + SiteRelativePath + + Site Relative Folder Path + + String + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + + 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. + + SPOnlineConnection + + + + + + Includes + + Specify properties to include when retrieving objects from the server. + + String[] + + String[] + + + + + SiteRelativePath + + Site Relative Folder Path + + String + + String + + + + + Web + + The web to apply the command to. Omit this parameter to use the current web. + + WebPipeBind + + WebPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + Microsoft.SharePoint.Client.Folder + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Resolve-PnPFolder -SiteRelativePath "demofolder/subfolder" + + Creates a folder called subfolder in a folder called demofolder located in the root folder of the site. If the folder hierarchy does not exist, it will be created. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + Get-PnPFolder: + https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/GetPnPFolder.md + + + + + + Restore-PnPRecycleBinItem + + Restores the provided recycle bin item to its original location + + + + + Restore + PnPRecycleBinItem + + + + + Restore-PnPRecycleBinItem + + Identity + + Id of the recycle bin item or the recycle bin item object itself to restore + + RecycleBinItemPipeBind + + + Force + + If provided, no confirmation will be asked to restore the recycle bin item + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Restore-PnPRecycleBinItem + + All + + If provided all items will be stored + + SwitchParameter + + + Force + + If provided, no confirmation will be asked to restore the recycle bin item + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + All + + If provided all items will be stored + + SwitchParameter + + SwitchParameter + + + + + Force + + If provided, no confirmation will be asked to restore the recycle bin item + + SwitchParameter + + SwitchParameter + + + + + Identity + + Id of the recycle bin item or the recycle bin item object itself to restore + + RecycleBinItemPipeBind + + RecycleBinItemPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Restore-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442 + + Restores the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 to its original location + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPRecycleBinItems | ? FileLeafName -like "*.docx" | Restore-PnpRecycleBinItem + + Restores all the items in the first and second stage recycle bins to their original location of which the filename ends with the .docx extension + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Restore-PnPTenantRecycleBinItem + + * Supported in: SharePoint Online. + +Restores a site collection from the tenant scoped recycle bin + + + + + Restore + PnPTenantRecycleBinItem + + + + The Reset-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be restored to its original location. + + + + Restore-PnPTenantRecycleBinItem + + Url + + Url of the site collection to restore from the tenant recycle bin + + String + + + Wait + + If provided, the PowerShell execution will halt until the site restore process has completed + + SwitchParameter + + + Force + + If provided, no confirmation will be asked to restore the site collection from the tenant recycle bin + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Force + + If provided, no confirmation will be asked to restore the site collection from the tenant recycle bin + + SwitchParameter + + SwitchParameter + + + + + Url + + Url of the site collection to restore from the tenant recycle bin + + String + + String + + + + + Wait + + If provided, the PowerShell execution will halt until the site restore process has completed + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso + + This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait + + This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location and will wait with executing further PowerShell commands until the site collection restore has completed + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Resume-PnPWorkflowInstance + + Resume a workflow + + + + + Resume + PnPWorkflowInstance + + + + Resumes a previously stopped workflow instance + + + + Resume-PnPWorkflowInstance + + Identity + + The instance to resume + + WorkflowInstancePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The instance to resume + + WorkflowInstancePipeBind + + WorkflowInstancePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Resume-PnPWorkflowInstance -identity $wfInstance + + Resumes the workflow instance, this can be the Guid of the instance or the instance itself. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Revoke-PnPSiteDesignRights + + * Supported in: SharePoint Online. + +Revokes the specified principals rights to use the site design. + + + + + Revoke + PnPSiteDesignRights + + + + + Revoke-PnPSiteDesignRights + + Principals + + One or more principals to revoke. + + String[] + + + Identity + + The site design to use. + + TenantSiteDesignPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The site design to use. + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + Principals + + One or more principals to revoke. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Revoke-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com" + + Revokes rights to the specified principals on the site design specified + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd | Revoke-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com" + + Revokes rights to the specified principals on the site design specified + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Save-PnPProvisioningTemplate + + Saves a PnP file to the file systems + + + + + Save + PnPProvisioningTemplate + + + + + Save-PnPProvisioningTemplate + + InputInstance + + Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. + + ProvisioningTemplate + + + Out + + Filename to write to, optionally including full path. + + String + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + + TemplateProviderExtensions + + Allows you to specify the ITemplateProviderExtension to execute while saving a template. + + ITemplateProviderExtension[] + + + + + + Force + + Specifying the Force parameter will skip the confirmation question. + + SwitchParameter + + SwitchParameter + + + + + InputInstance + + Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. + + ProvisioningTemplate + + ProvisioningTemplate + + + + + Out + + Filename to write to, optionally including full path. + + String + + String + + + + + TemplateProviderExtensions + + Allows you to specify the ITemplateProviderExtension to execute while saving a template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Save-PnPProvisioningTemplate -InputInstance $template -Out .\template.pnp + + Saves a PnP file to the file systems + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Send-PnPMail + + Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information. + + + + + Send + PnPMail + + + + + Send-PnPMail + + To + + List of recipients + + String[] + + + Subject + + Subject of the email + + String + + + Body + + Body of the email + + String + + + Server + + + + String + + + From + + If using from address, you also have to provide a password + + String + + + Password + + If using a password, you also have to provide the associated from address + + String + + + Cc + + List of recipients on CC + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Body + + Body of the email + + String + + String + + + + + Cc + + List of recipients on CC + + String[] + + String[] + + + + + From + + If using from address, you also have to provide a password + + String + + String + + + + + Password + + If using a password, you also have to provide the associated from address + + String + + String + + + + + Server + + + + String + + String + + + + + Subject + + Subject of the email + + String + + String + + + + + To + + List of recipients + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Send-PnPMail -To address@tenant.sharepointonline.com -Subject test -Body test + + Sends an e-mail using the SharePoint SendEmail method using the current context. E-mail is sent from the system account and can only be sent to accounts in the same tenant + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@tenant.onmicrosoft.com -Password xyz + + Sends an e-mail via Office 365 SMTP and requires a from address and password. E-mail is sent from the from user and can be sent to both internal and external addresses. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@server.net -Password xyz -Server yoursmtp.server.net + + Sends an e-mail via a custom SMTP server and requires a from address and password. E-mail is sent from the from user. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPAppSideLoading + + Enables the App SideLoading Feature on a site + + + + + Set + PnPAppSideLoading + + + + + Set-PnPAppSideLoading + + On + + + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Set-PnPAppSideLoading + + Off + + + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Off + + + + SwitchParameter + + SwitchParameter + + + + + On + + + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPAppSideLoading -On + + This will turn on App side loading + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPAppSideLoading -Off + + This will turn off App side loading + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPAuditing + + Set Auditing setting for a site + + + + + Set + PnPAuditing + + + + + Set-PnPAuditing + + RetentionTime + + Set the retention time + + Int32 + + + TrimAuditLog + + Trim the audit log + + SwitchParameter + + + EditItems + + Audit editing items + + SwitchParameter + + + CheckOutCheckInItems + + Audit checking out or checking in items + + SwitchParameter + + + MoveCopyItems + + Audit moving or copying items to another location in the site. + + SwitchParameter + + + DeleteRestoreItems + + Audit deleting or restoring items + + SwitchParameter + + + EditContentTypesColumns + + Audit editing content types and columns + + SwitchParameter + + + SearchContent + + Audit searching site content + + SwitchParameter + + + EditUsersPermissions + + Audit editing users and permissions + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Set-PnPAuditing + + EnableAll + + Enable all audit flags + + SwitchParameter + + + RetentionTime + + Set the retention time + + Int32 + + + TrimAuditLog + + Trim the audit log + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + Set-PnPAuditing + + DisableAll + + Disable all audit flags + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + CheckOutCheckInItems + + Audit checking out or checking in items + + SwitchParameter + + SwitchParameter + + + + + DeleteRestoreItems + + Audit deleting or restoring items + + SwitchParameter + + SwitchParameter + + + + + DisableAll + + Disable all audit flags + + SwitchParameter + + SwitchParameter + + + + + EditContentTypesColumns + + Audit editing content types and columns + + SwitchParameter + + SwitchParameter + + + + + EditItems + + Audit editing items + + SwitchParameter + + SwitchParameter + + + + + EditUsersPermissions + + Audit editing users and permissions + + SwitchParameter + + SwitchParameter + + + + + EnableAll + + Enable all audit flags + + SwitchParameter + + SwitchParameter + + + + + MoveCopyItems + + Audit moving or copying items to another location in the site. + + SwitchParameter + + SwitchParameter + + + + + RetentionTime + + Set the retention time + + Int32 + + Int32 + + + + + SearchContent + + Audit searching site content + + SwitchParameter + + SwitchParameter + + + + + TrimAuditLog + + Trim the audit log + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPAuditing -EnableAll + + Enables all auditing settings for the current site + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPAuditing -DisableAll + + Disables all auditing settings for the current site + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPAuditing -RetentionTime 7 + + Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPAuditing -TrimAuditLog + + Enables the automatic trimming of the audit log + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Set-PnPAuditing -RetentionTime 7 -CheckOutCheckInItems -MoveCopyItems -SearchContent + + Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log. + +Do auditing for: +- Checking out or checking in items +- Moving or copying items to another location in the site +- Searching site content + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPAvailablePageLayouts + + Sets the available page layouts for the current site + + + + + Set + PnPAvailablePageLayouts + + + + + Set-PnPAvailablePageLayouts + + PageLayouts + + An array of page layout files to set as available page layouts for the site. + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPAvailablePageLayouts + + AllowAllPageLayouts + + An array of page layout files to set as available page layouts for the site. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPAvailablePageLayouts + + InheritPageLayouts + + Set the available page layouts to inherit from the parent site. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AllowAllPageLayouts + + An array of page layout files to set as available page layouts for the site. + + SwitchParameter + + SwitchParameter + + + + + InheritPageLayouts + + Set the available page layouts to inherit from the parent site. + + SwitchParameter + + SwitchParameter + + + + + PageLayouts + + An array of page layout files to set as available page layouts for the site. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPClientSidePage + + * Supported in: SharePoint Online. + +Sets parameters of a Client-Side Page + + + + + Set + PnPClientSidePage + + + + + Set-PnPClientSidePage + + Identity + + The name/identity of the page + + ClientSidePagePipeBind + + + Name + + Sets the name of the page. + + String + + + Title + + Sets the title of the page. + + String + + + LayoutType + + Sets the layout type of the page. (Default = Article) + + ClientSidePageLayoutType + + + PromoteAs + + Allows to promote the page for a specific purpose (HomePage | NewsPage) + + ClientSidePagePromoteType + + + CommentsEnabled + + Enables or Disables the comments on the page + + SwitchParameter + + + Publish + + Publishes the page once it is saved. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + CommentsEnabled + + Enables or Disables the comments on the page + + SwitchParameter + + SwitchParameter + + + + + Identity + + The name/identity of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + LayoutType + + Sets the layout type of the page. (Default = Article) + + ClientSidePageLayoutType + + ClientSidePageLayoutType + + + + + Name + + Sets the name of the page. + + String + + String + + + + + PromoteAs + + Allows to promote the page for a specific purpose (HomePage | NewsPage) + + ClientSidePagePromoteType + + ClientSidePagePromoteType + + + + + Publish + + Publishes the page once it is saved. + + SwitchParameter + + SwitchParameter + + + + + Title + + Sets the title of the page. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPClientSidePage -Identity "MyPage" -LayoutType Home -Title "My Page" + + Updates the properties of the Client-Side page named 'MyPage' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled + + Enables the comments on the Client-Side page named 'MyPage' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled:$false + + Disables the comments on the Client-Side page named 'MyPage' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPClientSideText + + * Supported in: SharePoint Online. + +Set Client-Side Text Component properties + + + + + Set + PnPClientSideText + + + + Sets the rendered text in existing client side text component + + + + Set-PnPClientSideText + + InstanceId + + The instance id of the text component + + GuidPipeBind + + + Text + + Text to set + + String + + + Page + + The name of the page + + ClientSidePagePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + InstanceId + + The instance id of the text component + + GuidPipeBind + + GuidPipeBind + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + Text + + Text to set + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSetClientSideText -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Text "MyText" + + Sets the text of the client side text component. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPClientSideWebPart + + * Supported in: SharePoint Online. + +Set Client-Side Web Part properties + + + + + Set + PnPClientSideWebPart + + + + Sets specific client side webpart properties. Notice that the title parameter will only set the -internal- title of webpart. The title which is shown in the UI will, if possible, have to be set using the PropertiesJson parameter. Use Get-PnPClientSideComponent to retrieve the instance id and properties of a webpart. + + + + Set-PnPClientSideWebPart + + Identity + + The identity of the webpart. This can be the webpart instance id or the title of a webpart + + ClientSideWebPartPipeBind + + + Page + + The name of the page + + ClientSidePagePipeBind + + + Title + + Sets the internal title of the webpart. Notice that this will NOT set a visible title. + + String + + + PropertiesJson + + Sets the properties as a JSON string. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The identity of the webpart. This can be the webpart instance id or the title of a webpart + + ClientSideWebPartPipeBind + + ClientSideWebPartPipeBind + + + + + Page + + The name of the page + + ClientSidePagePipeBind + + ClientSidePagePipeBind + + + + + PropertiesJson + + Sets the properties as a JSON string. + + String + + String + + + + + Title + + Sets the internal title of the webpart. Notice that this will NOT set a visible title. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPClientSideWebPart -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -PropertiesJson $myproperties + + Sets the properties of the client side webpart given in the $myproperties variable. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPContext + + Set the ClientContext + + + + + Set + PnPContext + + + + Sets the Client Context to use by the cmdlets, which allows easy context switching. See examples for details. + + + + Set-PnPContext + + Context + + The ClientContext to set + + ClientContext + + + + + + Context + + The ClientContext to set + + ClientContext + + ClientContext + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Url $siteAurl -Credentials $credentials +PS:> $ctx = Get-PnPContext +PS:> Get-PnPList # returns the lists from site specified with $siteAurl +PS:> Connect-PnPOnline -Url $siteBurl -Credentials $credentials +PS:> Get-PnPList # returns the lists from the site specified with $siteBurl +PS:> Set-PnPContext -Context $ctx # switch back to site A +PS:> Get-PnPList # returns the lists from site A + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPDefaultColumnValues + + Sets default column values for a document library + + + + + Set + PnPDefaultColumnValues + + + + Sets default column values for a document library, per folder, or for the root folder if the folder parameter has not been specified. Supports both text and taxonomy fields. + + + + Set-PnPDefaultColumnValues + + Field + + The internal name, id or a reference to a field + + FieldPipeBind + + + Value + + A list of values. In case of a text field the values will be concatenated, separated by a semi-colon. In case of a taxonomy field multiple values will added. In case of people field multiple values will be added. + + String[] + + + List + + The ID, Name or Url of the list. + + ListPipeBind + + + Folder + + A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/') + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Field + + The internal name, id or a reference to a field + + FieldPipeBind + + FieldPipeBind + + + + + Folder + + A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/') + + String + + String + + + + + List + + The ID, Name or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + Value + + A list of values. In case of a text field the values will be concatenated, separated by a semi-colon. In case of a taxonomy field multiple values will added. In case of people field multiple values will be added. + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "Company|Locations|Stockholm" + + Sets a default value for the enterprise keywords field on a library to a term called "Stockholm", located in the "Locations" term set, which is part of the "Company" term group + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "15c4c4e4-4b67-4894-a1d8-de5ff811c791" + + Sets a default value for the enterprise keywords field on a library to a term with the id "15c4c4e4-4b67-4894-a1d8-de5ff811c791". You need to ensure the term is valid for the field. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPDefaultColumnValues -List Documents -Field MyTextField -Value "DefaultValue" + + Sets a default value for the MyTextField text field on a library to a value of "DefaultValue" + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "1;#Foo Bar" + + Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> $user = New-PnPUser -LoginName foobar@contoso.com +PS:> Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "$($user.Id);#$($user.LoginName)" + + Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> $user1 = New-PnPUser -LoginName user1@contoso.com +PS:> $user2 = New-PnPUser -LoginName user2@contoso.com +PS:> Set-PnPDefaultColumnValues -List Documents -Field MyMultiPeopleField -Value "$($user1.Id);#$($user1.LoginName)","$($user2.Id);#$($user2.LoginName)" + + Sets a default value for the MyMultiPeopleField people field on a library to a value of "User 1" and "User 2" using the id from the user information list. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPDefaultContentTypeToList + + Sets the default content type for a list + + + + + Set + PnPDefaultContentTypeToList + + + + + Set-PnPDefaultContentTypeToList + + List + + The name of a list, an ID or the actual list object to update + + ListPipeBind + + + ContentType + + The content type object that needs to be set as the default content type on the list. Content Type needs to be present on the list. + + ContentTypePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + The content type object that needs to be set as the default content type on the list. Content Type needs to be present on the list. + + ContentTypePipeBind + + ContentTypePipeBind + + + + + List + + The name of a list, an ID or the actual list object to update + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPDefaultContentTypeToList -List "Project Documents" -ContentType "Project" + + This will set the Project content type (which has already been added to a list) as the default content type + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPDefaultPageLayout + + Sets a specific page layout to be the default page layout for a publishing site + + + + + Set + PnPDefaultPageLayout + + + + + Set-PnPDefaultPageLayout + + Title + + Title of the page layout + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPDefaultPageLayout + + InheritFromParentSite + + Set the default page layout to be inherited from the parent site. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + InheritFromParentSite + + Set the default page layout to be inherited from the parent site. + + SwitchParameter + + SwitchParameter + + + + + Title + + Title of the page layout + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPDefaultPageLayout -Title projectpage.aspx + + Sets projectpage.aspx to be the default page layout for the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPDefaultPageLayout -Title test/testpage.aspx + + Sets a page layout in a folder in the Master Page & Page Layout gallery, such as _catalog/masterpage/test/testpage.aspx, to be the default page layout for the current web + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPDefaultPageLayout -InheritFromParentSite + + Sets the default page layout to be inherited from the parent site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPField + + Changes one or more properties of a field in a specific list or for the whole web + + + + + Set + PnPField + + + + + Set-PnPField + + Values + + Hashtable of properties to update on the field. Use the syntax @{property1="value";property2="value"}. + + Hashtable + + + Identity + + The field object, internal field name (case sensitive) or field id to update + + FieldPipeBind + + + List + + The list object, name or id where to update the field. If omited the field will be updated on the web. + + ListPipeBind + + + UpdateExistingLists + + If provided, the field will be updated on existing lists that use it as well. If not provided or set to $false, existing lists using the field will remain unchanged but new lists will get the updated field. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The field object, internal field name (case sensitive) or field id to update + + FieldPipeBind + + FieldPipeBind + + + + + List + + The list object, name or id where to update the field. If omited the field will be updated on the web. + + ListPipeBind + + ListPipeBind + + + + + UpdateExistingLists + + If provided, the field will be updated on existing lists that use it as well. If not provided or set to $false, existing lists using the field will remain unchanged but new lists will get the updated field. + + SwitchParameter + + SwitchParameter + + + + + Values + + Hashtable of properties to update on the field. Use the syntax @{property1="value";property2="value"}. + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"} + + Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will not be updated. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"} -UpdateExistingLists + + Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will also be updated. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPField -List "Tasks" -Identity "AssignedTo" -Values @{JSLink="customrendering.js"} + + Updates the AssignedTo field on the Tasks list to use customrendering.js for the JSLink + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPDocumentSetField + + Sets a site column from the available content types to a document set + + + + + Set + PnPDocumentSetField + + + + + Set-PnPDocumentSetField + + DocumentSet + + The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + + Field + + The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object + + FieldPipeBind + + + SetSharedField + + Set the field as a Shared Field + + SwitchParameter + + + SetWelcomePageField + + Set the field as a Welcome Page field + + SwitchParameter + + + RemoveSharedField + + Removes the field as a Shared Field + + SwitchParameter + + + RemoveWelcomePageField + + Removes the field as a Welcome Page Field + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + DocumentSet + + The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object + + DocumentSetPipeBind + + DocumentSetPipeBind + + + + + Field + + The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object + + FieldPipeBind + + FieldPipeBind + + + + + RemoveSharedField + + Removes the field as a Shared Field + + SwitchParameter + + SwitchParameter + + + + + RemoveWelcomePageField + + Removes the field as a Welcome Page Field + + SwitchParameter + + SwitchParameter + + + + + SetSharedField + + Set the field as a Shared Field + + SwitchParameter + + SwitchParameter + + + + + SetWelcomePageField + + Set the field as a Welcome Page field + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -SetSharedField -SetWelcomePageField + + This will set the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -RemoveSharedField -RemoveWelcomePageField + + This will remove the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPFileCheckedIn + + Checks in a file + + + + + Set + PnPFileCheckedIn + + + + + Set-PnPFileCheckedIn + + Url + + The server relative url of the file to check in + + String + + + CheckinType + + The check in type to use. Defaults to Major + + CheckinType + + + Comment + + The check in comment + + String + + + Approve + + Approve file + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Approve + + Approve file + + SwitchParameter + + SwitchParameter + + + + + CheckinType + + The check in type to use. Defaults to Major + + CheckinType + + CheckinType + + + + + Comment + + The check in comment + + String + + String + + + + + Url + + The server relative url of the file to check in + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx" + + Checks in the file "Contract.docx" in the "Documents" library + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx" -CheckinType MinorCheckin -Comment "Smaller changes" + + Checks in the file "Contract.docx" in the "Documents" library as a minor version and adds the check in comment "Smaller changes" + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPFileCheckedOut + + Checks out a file + + + + + Set + PnPFileCheckedOut + + + + + Set-PnPFileCheckedOut + + Url + + The server relative url of the file to check out + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Url + + The server relative url of the file to check out + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:>Set-PnPFileCheckedOut -Url "/sites/testsite/subsite/Documents/Contract.docx" + + Checks out the file "Contract.docx" in the "Documents" library. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPGroup + + Updates a group + + + + + Set + PnPGroup + + + + + Set-PnPGroup + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + + SetAssociatedGroup + + One of the associated group types (Visitors, Members, Owners + + AssociatedGroupType + + + AddRole + + Name of the permission set to add to this SharePoint group + + String + + + RemoveRole + + Name of the permission set to remove from this SharePoint group + + String + + + Title + + The title for the group + + String + + + Owner + + The owner for the group, which can be a user or another group + + String + + + Description + + The description for the group + + String + + + AllowRequestToJoinLeave + + A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group + + Boolean + + + AutoAcceptRequestToJoinLeave + + A switch parameter that specifies whether users are automatically added or removed when they make a request + + Boolean + + + AllowMembersEditMembership + + A switch parameter that specifies whether group members can modify membership in the group + + Boolean + + + OnlyAllowMembersViewMembership + + A switch parameter that specifies whether only group members are allowed to view the list of members in the group + + Boolean + + + RequestToJoinEmail + + The e-mail address to which membership requests are sent + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddRole + + Name of the permission set to add to this SharePoint group + + String + + String + + + + + AllowMembersEditMembership + + A switch parameter that specifies whether group members can modify membership in the group + + Boolean + + Boolean + + + + + AllowRequestToJoinLeave + + A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group + + Boolean + + Boolean + + + + + AutoAcceptRequestToJoinLeave + + A switch parameter that specifies whether users are automatically added or removed when they make a request + + Boolean + + Boolean + + + + + Description + + The description for the group + + String + + String + + + + + Identity + + A group object, an ID or a name of a group + + GroupPipeBind + + GroupPipeBind + + + + + OnlyAllowMembersViewMembership + + A switch parameter that specifies whether only group members are allowed to view the list of members in the group + + Boolean + + Boolean + + + + + Owner + + The owner for the group, which can be a user or another group + + String + + String + + + + + RemoveRole + + Name of the permission set to remove from this SharePoint group + + String + + String + + + + + RequestToJoinEmail + + The e-mail address to which membership requests are sent + + String + + String + + + + + SetAssociatedGroup + + One of the associated group types (Visitors, Members, Owners + + AssociatedGroupType + + AssociatedGroupType + + + + + Title + + The title for the group + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPGroup -Identity 'My Site Members' -SetAssociatedGroup Members + + Sets the SharePoint group with the name 'My Site Members' as the associated members group + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPGroup -Identity 'My Site Members' -Owner 'site owners' + + Sets the SharePoint group with the name 'site owners' as the owner of the SharePoint group with the name 'My Site Members' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPGroupPermissions + + Adds and/or removes permissions of a specific SharePoint group + + + + + Set + PnPGroupPermissions + + + + + Set-PnPGroupPermissions + + Identity + + Get the permissions of a specific group by name + + GroupPipeBind + + + List + + The list to apply the command to. + + ListPipeBind + + + AddRole + + Name of the permission set to add to this SharePoint group + + String[] + + + RemoveRole + + Name of the permission set to remove from this SharePoint group + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddRole + + Name of the permission set to add to this SharePoint group + + String[] + + String[] + + + + + Identity + + Get the permissions of a specific group by name + + GroupPipeBind + + GroupPipeBind + + + + + List + + The list to apply the command to. + + ListPipeBind + + ListPipeBind + + + + + RemoveRole + + Name of the permission set to remove from this SharePoint group + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole Contribute + + Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read' + + Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design') + + Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members' + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design') + + Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members' + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute') + + Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPHideDefaultThemes + + * Supported in: SharePoint Online. + +Defines if the default / OOTB themes should be visible to users or not. + + + + + Set + PnPHideDefaultThemes + + + + Use this cmdlet to hide or show the default themes to users + +You must be a SharePoint Online global administrator to run the cmdlet. + + + + Set-PnPHideDefaultThemes + + HideDefaultThemes + + Defines if the default themes should be visible or hidden + + Boolean + + + 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. + + SPOnlineConnection + + + + + + HideDefaultThemes + + Defines if the default themes should be visible or hidden + + Boolean + + Boolean + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $true + + This example hides the default themes + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $false + + This example shows the default themes + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPHomePage + + Sets the home page of the current web. + + + + + Set + PnPHomePage + + + + + Set-PnPHomePage + + RootFolderRelativeUrl + + The root folder relative url of the homepage, e.g. 'sitepages/home.aspx' + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + RootFolderRelativeUrl + + The root folder relative url of the homepage, e.g. 'sitepages/home.aspx' + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx + + Sets the home page to the home.aspx file which resides in the SitePages library + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPHubSite + + * Supported in: SharePoint Online. + +Sets hubsite properties + + + + + Set + PnPHubSite + + + + + Set-PnPHubSite + + 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. + + SPOnlineConnection + + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Title "My New Title" + + Sets the title of the hubsite + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPIndexedProperties + + Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed. + + + + + Set + PnPIndexedProperties + + + + + Set-PnPIndexedProperties + + Keys + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Keys + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPInPlaceRecordsManagement + + Activates or deactivates in the place records management feature. + + + + + Set + PnPInPlaceRecordsManagement + + + + + Set-PnPInPlaceRecordsManagement + + Enabled + + + + Boolean + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Enabled + + + + Boolean + + Boolean + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPInPlaceRecordsManagement -Enabled $true + + Activates In Place Records Management + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPInPlaceRecordsManagement -Enabled $false + + Deactivates In Place Records Management + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPList + + Updates list settings + + + + + Set + PnPList + + + + + Set-PnPList + + Identity + + The ID, Title or Url of the list. + + ListPipeBind + + + EnableContentTypes + + Set to $true to enable content types, set to $false to disable content types + + Boolean + + + BreakRoleInheritance + + If used the security inheritance is broken for this list + + SwitchParameter + + + CopyRoleAssignments + + If used the roles are copied from the parent web + + SwitchParameter + + + ClearSubscopes + + If used the unique permissions are cleared from child objects and they can inherit role assignments from this object + + SwitchParameter + + + Title + + The title of the list + + String + + + Hidden + + Hide the list from the SharePoint UI. Set to $true to hide, $false to show. + + Boolean + + + EnableAttachments + + Enable or disable attachments. Set to $true to enable, $false to disable. + + Boolean + + + EnableVersioning + + Enable or disable versioning. Set to $true to enable, $false to disable. + + Boolean + + + EnableMinorVersions + + Enable or disable minor versions versioning. Set to $true to enable, $false to disable. + + Boolean + + + MajorVersions + + Maximum major versions to keep + + UInt32 + + + MinorVersions + + Maximum minor versions to keep + + UInt32 + + + EnableModeration + + Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable. + + Boolean + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + BreakRoleInheritance + + If used the security inheritance is broken for this list + + SwitchParameter + + SwitchParameter + + + + + ClearSubscopes + + If used the unique permissions are cleared from child objects and they can inherit role assignments from this object + + SwitchParameter + + SwitchParameter + + + + + CopyRoleAssignments + + If used the roles are copied from the parent web + + SwitchParameter + + SwitchParameter + + + + + EnableAttachments + + Enable or disable attachments. Set to $true to enable, $false to disable. + + Boolean + + Boolean + + + + + EnableContentTypes + + Set to $true to enable content types, set to $false to disable content types + + Boolean + + Boolean + + + + + EnableMinorVersions + + Enable or disable minor versions versioning. Set to $true to enable, $false to disable. + + Boolean + + Boolean + + + + + EnableModeration + + Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable. + + Boolean + + Boolean + + + + + EnableVersioning + + Enable or disable versioning. Set to $true to enable, $false to disable. + + Boolean + + Boolean + + + + + Hidden + + Hide the list from the SharePoint UI. Set to $true to hide, $false to show. + + Boolean + + Boolean + + + + + Identity + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + MajorVersions + + Maximum major versions to keep + + UInt32 + + UInt32 + + + + + MinorVersions + + Maximum minor versions to keep + + UInt32 + + UInt32 + + + + + Title + + The title of the list + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Set-PnPList -Identity "Demo List" -EnableContentTypes $true + + Switches the Enable Content Type switch on the list + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Set-PnPList -Identity "Demo List" -Hidden $true + + Hides the list from the SharePoint UI. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + Set-PnPList -Identity "Demo List" -EnableVersioning $true + + Turns on major versions on a list + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + Set-PnPList -Identity "Demo List" -EnableVersioning $true -MajorVersions 20 + + Turns on major versions on a list and sets the maximum number of Major Versions to keep to 20. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + Set-PnPList -Identity "Demo Library" -EnableVersioning $true -EnableMinorVersions $true -MajorVersions 20 -MinorVersions 5 + + Turns on major versions on a document library and sets the maximum number of Major versions to keep to 20 and sets the maximum of Minor versions to 5. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + Set-PnPList -Identity "Demo List" -EnableAttachments $true + + Turns on attachments on a list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListInformationRightsManagement + + Get the site closure status of the site which has a site policy applied + + + + + Set + PnPListInformationRightsManagement + + + + + Set-PnPListInformationRightsManagement + + List + + The list to set Information Rights Management (IRM) settings for. + + ListPipeBind + + + Enable + + Specifies whether Information Rights Management (IRM) is enabled for the list. + + Boolean + + + EnableExpiration + + Specifies whether Information Rights Management (IRM) expiration is enabled for the list. + + Boolean + + + EnableRejection + + Specifies whether Information Rights Management (IRM) rejection is enabled for the list. + + Boolean + + + AllowPrint + + Sets a value indicating whether the viewer can print the downloaded document. + + Boolean + + + AllowScript + + Sets a value indicating whether the viewer can run a script on the downloaded document. + + Boolean + + + AllowWriteCopy + + Sets a value indicating whether the viewer can write on a copy of the downloaded document. + + Boolean + + + DisableDocumentBrowserView + + Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document. + + Boolean + + + DocumentAccessExpireDays + + Sets the number of days after which the downloaded document will expire. + + Int32 + + + DocumentLibraryProtectionExpireDate + + Sets the date after which the Information Rights Management (IRM) protection of this document library will stop. + + DateTime + + + EnableDocumentAccessExpire + + Sets a value indicating whether the downloaded document will expire. + + Boolean + + + EnableDocumentBrowserPublishingView + + Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view. + + Boolean + + + EnableGroupProtection + + Sets a value indicating whether the permission of the downloaded document is applicable to a group. + + Boolean + + + EnableLicenseCacheExpire + + Sets whether a user must verify their credentials after some interval. + + Boolean + + + LicenseCacheExpireDays + + Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license. + + Int32 + + + GroupName + + Sets the group name (email address) that the permission is also applicable to. + + String + + + PolicyDescription + + Sets the permission policy description. + + String + + + PolicyTitle + + Sets the permission policy title. + + String + + + TemplateId + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AllowPrint + + Sets a value indicating whether the viewer can print the downloaded document. + + Boolean + + Boolean + + + + + AllowScript + + Sets a value indicating whether the viewer can run a script on the downloaded document. + + Boolean + + Boolean + + + + + AllowWriteCopy + + Sets a value indicating whether the viewer can write on a copy of the downloaded document. + + Boolean + + Boolean + + + + + DisableDocumentBrowserView + + Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document. + + Boolean + + Boolean + + + + + DocumentAccessExpireDays + + Sets the number of days after which the downloaded document will expire. + + Int32 + + Int32 + + + + + DocumentLibraryProtectionExpireDate + + Sets the date after which the Information Rights Management (IRM) protection of this document library will stop. + + DateTime + + DateTime + + + + + Enable + + Specifies whether Information Rights Management (IRM) is enabled for the list. + + Boolean + + Boolean + + + + + EnableDocumentAccessExpire + + Sets a value indicating whether the downloaded document will expire. + + Boolean + + Boolean + + + + + EnableDocumentBrowserPublishingView + + Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view. + + Boolean + + Boolean + + + + + EnableExpiration + + Specifies whether Information Rights Management (IRM) expiration is enabled for the list. + + Boolean + + Boolean + + + + + EnableGroupProtection + + Sets a value indicating whether the permission of the downloaded document is applicable to a group. + + Boolean + + Boolean + + + + + EnableLicenseCacheExpire + + Sets whether a user must verify their credentials after some interval. + + Boolean + + Boolean + + + + + EnableRejection + + Specifies whether Information Rights Management (IRM) rejection is enabled for the list. + + Boolean + + Boolean + + + + + GroupName + + Sets the group name (email address) that the permission is also applicable to. + + String + + String + + + + + LicenseCacheExpireDays + + Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license. + + Int32 + + Int32 + + + + + List + + The list to set Information Rights Management (IRM) settings for. + + ListPipeBind + + ListPipeBind + + + + + PolicyDescription + + Sets the permission policy description. + + String + + String + + + + + PolicyTitle + + Sets the permission policy title. + + String + + String + + + + + TemplateId + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPListInformationRightsManagement -List "Documents" -Enabled $true + + Enables Information Rights Management (IRM) on the list. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListItem + + Updates a list item + + + + + Set + PnPListItem + + + + + Set-PnPListItem + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + ContentType + + Specify either the name, ID or an actual content type + + ContentTypePipeBind + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"TextField" = "Title New"} + +Multiple lines of text: -Values @{"MultiTextField" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiTextField" = "<strong>New</strong> text"} + +Choice: -Values @{"ChoiceField" = "Value 1"} + +Number: -Values @{"NumberField" = "10"} + +Currency: -Values @{"NumberField" = "10"} + +Currency: -Values @{"CurrencyField" = "10"} + +Date and Time: -Values @{"DateAndTimeField" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"LookupField" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNoField" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"PersonField" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = ("CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR")} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = ("fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593")} + +Hyperlink or Picture: -Values @{"HyperlinkField" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + + SystemUpdate + + Update the item without creating a new version. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ContentType + + Specify either the name, ID or an actual content type + + ContentTypePipeBind + + ContentTypePipeBind + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + SystemUpdate + + Update the item without creating a new version. + + SwitchParameter + + SwitchParameter + + + + + Values + + Use the internal names of the fields when specifying field names. + +Single line of text: -Values @{"TextField" = "Title New"} + +Multiple lines of text: -Values @{"MultiTextField" = "New text\n\nMore text"} + +Rich text: -Values @{"MultiTextField" = "<strong>New</strong> text"} + +Choice: -Values @{"ChoiceField" = "Value 1"} + +Number: -Values @{"NumberField" = "10"} + +Currency: -Values @{"NumberField" = "10"} + +Currency: -Values @{"CurrencyField" = "10"} + +Date and Time: -Values @{"DateAndTimeField" = "03/10/2015 14:16"} + +Lookup (id of lookup value): -Values @{"LookupField" = "2"} + +Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} + +Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} + +Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} + +Yes/No: -Values @{"YesNoField" = $false} + +Person/Group (id of user/group in Site User Info List or email of the user, seperate multiple values with a comma): -Values @{"PersonField" = "user1@domain.com","21"} + +Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} + +Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term + +Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = ("CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR")} + +Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = ("fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593")} + +Hyperlink or Picture: -Values @{"HyperlinkField" = "https://github.com/OfficeDev/, OfficePnp"} + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.ListItem + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + Set-PnPListItem -List "Demo List" -Identity 1 -Values @{"Title" = "Test Title"; "Category"="Test Category"} + + Sets fields value in the list item with ID 1 in the "Demo List". It sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + Set-PnPListItem -List "Demo List" -Identity 1 -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"} + + Sets fields value in the list item with ID 1 in the "Demo List". It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + Set-PnPListItem -List "Demo List" -Identity $item -Values @{"Title" = "Test Title"; "Category"="Test Category"} + + Sets fields value in the list item which has been retrieved by for instance Get-PnPListItem. It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListItemAsRecord + + * Supported in: SharePoint Online. + +Declares a list item as a record + + + + + Set + PnPListItemAsRecord + + + + + Set-PnPListItemAsRecord + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + DeclarationDate + + The declaration date + + DateTime + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + DeclarationDate + + The declaration date + + DateTime + + DateTime + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPListItemAsRecord -List "Documents" -Identity 4 + + Declares the document in the documents library with id 4 as a record + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPListItemAsRecord -List "Documents" -Identity 4 -DeclarationDate $date + + Declares the document in the documents library with id as a record + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListItemPermission + + Sets list item permissions + + + + + Set + PnPListItemPermission + + + + + Set-PnPListItemPermission + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + InheritPermissions + + Inherit permissions from the list, removing unique permissions + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPListItemPermission + + Group + + + + GroupPipeBind + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String + + + RemoveRole + + The role that must be removed from the group or user + + String + + + ClearExisting + + Clear all existing permissions + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPListItemPermission + + User + + + + String + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String + + + RemoveRole + + The role that must be removed from the group or user + + String + + + ClearExisting + + Clear all existing permissions + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddRole + + The role that must be assigned to the group or user + + String + + String + + + + + ClearExisting + + Clear all existing permissions + + SwitchParameter + + SwitchParameter + + + + + Group + + + + GroupPipeBind + + GroupPipeBind + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + InheritPermissions + + Inherit permissions from the list, removing unique permissions + + SwitchParameter + + SwitchParameter + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + RemoveRole + + The role that must be removed from the group or user + + String + + String + + + + + User + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute' + + Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -RemoveRole 'Contribute' + + Removes the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute' -ClearExisting + + Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' and removes all other permissions + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -InheritPermissions + + Resets permissions for listitem with id 1 to inherit permissions from the list 'Documents' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListPermission + + Sets list permissions + + + + + Set + PnPListPermission + + + + + Set-PnPListPermission + + Group + + + + GroupPipeBind + + + Identity + + The ID or Title of the list. + + ListPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String + + + RemoveRole + + The role that must be removed from the group or user + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPListPermission + + User + + + + String + + + Identity + + The ID or Title of the list. + + ListPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String + + + RemoveRole + + The role that must be removed from the group or user + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddRole + + The role that must be assigned to the group or user + + String + + String + + + + + Group + + + + GroupPipeBind + + GroupPipeBind + + + + + Identity + + The ID or Title of the list. + + ListPipeBind + + ListPipeBind + + + + + RemoveRole + + The role that must be removed from the group or user + + String + + String + + + + + User + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -AddRole 'Contribute' + + Adds the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents' + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -RemoveRole 'Contribute' + + Removes the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents' + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPListRecordDeclaration + + * Supported in: SharePoint Online. + +The RecordDeclaration parameter supports 4 values: + +AlwaysAllowManualDeclaration +NeverAllowManualDeclaration +UseSiteCollectionDefaults + + + + + + Set + PnPListRecordDeclaration + + + + + Set-PnPListRecordDeclaration + + List + + The List to set the manual record declaration settings for + + ListPipeBind + + + ManualRecordDeclaration + + Defines the manual record declaration setting for the lists + + EcmListManualRecordDeclaration + + + AutoRecordDeclaration + + Defines if you want to set auto record declaration on the list + + Boolean + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AutoRecordDeclaration + + Defines if you want to set auto record declaration on the list + + Boolean + + Boolean + + + + + List + + The List to set the manual record declaration settings for + + ListPipeBind + + ListPipeBind + + + + + ManualRecordDeclaration + + Defines the manual record declaration setting for the lists + + EcmListManualRecordDeclaration + + EcmListManualRecordDeclaration + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPListRecordDeclaration -List "Documents" -ManualRecordDeclaration NeverAllowManualDeclaration + + Sets the manual record declaration to never allow + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPListRecordDeclaration -List "Documents" -AutoRecordDeclaration $true + + Turns on auto record declaration for the list + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPMasterPage + + Set the masterpage + + + + + Set + PnPMasterPage + + + + Sets the default master page of the current web. + + + + Set-PnPMasterPage + + MasterPageServerRelativeUrl + + Specifies the Master page URL based on the server relative URL + + String + + + CustomMasterPageServerRelativeUrl + + Specifies the custom Master page URL based on the server relative URL + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPMasterPage + + MasterPageSiteRelativeUrl + + Specifies the Master page URL based on the site relative URL + + String + + + CustomMasterPageSiteRelativeUrl + + Specifies the custom Master page URL based on the site relative URL + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + CustomMasterPageServerRelativeUrl + + Specifies the custom Master page URL based on the server relative URL + + String + + String + + + + + CustomMasterPageSiteRelativeUrl + + Specifies the custom Master page URL based on the site relative URL + + String + + String + + + + + MasterPageServerRelativeUrl + + Specifies the Master page URL based on the server relative URL + + String + + String + + + + + MasterPageSiteRelativeUrl + + Specifies the Master page URL based on the site relative URL + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master + + Sets the master page based on a server relative URL + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -CustomMasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master + + Sets the master page and custom master page based on a server relative URL + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master + + Sets the master page based on a site relative URL + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -CustomMasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master + + Sets the master page and custom master page based on a site relative URL + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPMinimalDownloadStrategy + + Activates or deactivates the minimal downloading strategy. + + + + + Set + PnPMinimalDownloadStrategy + + + + Activates or deactivates the minimal download strategy feature of a site + + + + Set-PnPMinimalDownloadStrategy + + On + + Turn minimal download strategy on + + SwitchParameter + + + Force + + Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPMinimalDownloadStrategy + + Off + + Turn minimal download strategy off + + SwitchParameter + + + Force + + Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors. + + SwitchParameter + + SwitchParameter + + + + + Off + + Turn minimal download strategy off + + SwitchParameter + + SwitchParameter + + + + + On + + Turn minimal download strategy on + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPMinimalDownloadStrategy -Off + + Will deactivate minimal download strategy (MDS) for the current web. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPMinimalDownloadStrategy -On + + Will activate minimal download strategy (MDS) for the current web. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPStorageEntity + + * Supported in: SharePoint Online. + +Set Storage Entities / Farm Properties. + + + + + Set + PnPStorageEntity + + + + + Set-PnPStorageEntity + + Key + + The key of the value to set. + + String + + + Value + + The value to set. + + String + + + Comment + + The comment to set. + + String + + + Description + + The description to set. + + String + + + 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. + + SPOnlineConnection + + + + + + Comment + + The comment to set. + + String + + String + + + + + Description + + The description to set. + + String + + String + + + + + Key + + The key of the value to set. + + String + + String + + + + + Value + + The value to set. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPStorageEntity -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description" + + Sets an existing or adds a new storage entity / farm property + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPPropertyBagValue + + Sets a property bag value + + + + + Set + PnPPropertyBagValue + + + + + Set-PnPPropertyBagValue + + Key + + + + String + + + Value + + + + String + + + Folder + + Site relative url of the folder. See examples for use. + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPPropertyBagValue + + Key + + + + String + + + Value + + + + String + + + Indexed + + + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Folder + + Site relative url of the folder. See examples for use. + + String + + String + + + + + Indexed + + + + SwitchParameter + + SwitchParameter + + + + + Key + + + + String + + String + + + + + Value + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue + + This sets or adds a value to the current web property bag + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder / + + This sets or adds a value to the root folder of the current web + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /MyFolder + + This sets or adds a value to the folder MyFolder which is located in the root folder of the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPProvisioningTemplateMetadata + + Sets metadata of a provisioning template + + + + + Set + PnPProvisioningTemplateMetadata + + + + + Set-PnPProvisioningTemplateMetadata + + Path + + Path to the xml or pnp file containing the provisioning template. + + String + + + TemplateDisplayName + + It can be used to specify the DisplayName of the template file that will be updated. + + String + + + TemplateImagePreviewUrl + + It can be used to specify the ImagePreviewUrl of the template file that will be updated. + + String + + + TemplateProperties + + It can be used to specify custom Properties for the template file that will be updated. + + Hashtable + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while extracting a template. + + ITemplateProviderExtension[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Path + + Path to the xml or pnp file containing the provisioning template. + + String + + String + + + + + TemplateDisplayName + + It can be used to specify the DisplayName of the template file that will be updated. + + String + + String + + + + + TemplateImagePreviewUrl + + It can be used to specify the ImagePreviewUrl of the template file that will be updated. + + String + + String + + + + + TemplateProperties + + It can be used to specify custom Properties for the template file that will be updated. + + Hashtable + + Hashtable + + + + + TemplateProviderExtensions + + Allows you to specify ITemplateProviderExtension to execute while extracting a template. + + ITemplateProviderExtension[] + + ITemplateProviderExtension[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateDisplayName "DisplayNameValue" + + Sets the DisplayName property of a provisioning template in XML format. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateDisplayName "DisplayNameValue" + + Sets the DisplayName property of a provisioning template in Office Open XML format. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateImagePreviewUrl "Full URL of the Image Preview" + + Sets the Url to the preview image of a provisioning template in XML format. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateImagePreviewUrl "Full URL of the Image Preview" + + Sets the to the preview image of a provisioning template in Office Open XML format. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"} + + Sets the property 'Property1' to the value 'Test Value 1' of a provisioning template in XML format. + + + + + + + + + + ------------------EXAMPLE 6--------------------- + + + + PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"} + + Sets the property 'Property1' to the value 'Test Value 1' of a provisioning template in Office Open XML format. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPRequestAccessEmails + + * Supported in: SharePoint Online. + +Sets Request Access Emails on a web + + + + + Set + PnPRequestAccessEmails + + + + + Set-PnPRequestAccessEmails + + Emails + + Email address(es) to set the RequestAccessEmails to + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Emails + + Email address(es) to set the RequestAccessEmails to + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPRequestAccessEmails -Emails someone@example.com + + This will update the request access e-mail address + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPRequestAccessEmails -Emails @( someone@example.com; someoneelse@example.com ) + + This will update multiple request access e-mail addresses + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSearchConfiguration + + Sets the search configuration + + + + + Set + PnPSearchConfiguration + + + + + Set-PnPSearchConfiguration + + Configuration + + Search configuration string + + String + + + Scope + + + + SearchConfigurationScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPSearchConfiguration + + Path + + Path to a search configuration + + String + + + Scope + + + + SearchConfigurationScope + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Configuration + + Search configuration string + + String + + String + + + + + Path + + Path to a search configuration + + String + + String + + + + + Scope + + + + SearchConfigurationScope + + SearchConfigurationScope + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSearchConfiguration -Configuration $config + + Sets the search configuration for the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPSearchConfiguration -Configuration $config -Scope Site + + Sets the search configuration for the current site collection + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPSearchConfiguration -Configuration $config -Scope Subscription + + Sets the search configuration for the current tenant + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription + + Reads the search configuration from the specified XML file and sets it for the current tenant + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSite + + * Supported in: SharePoint Online. + +Sets Site Collection properties. + + + + + Set + PnPSite + + + + + Set-PnPSite + + Classification + + The classification to set + + String + + + DisableFlows + + Disables flows for this site + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + Classification + + The classification to set + + String + + String + + + + + DisableFlows + + Disables flows for this site + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSite -Classification "HBI" + + Sets the current site classification to HBI + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPSite -Classification $null + + Unsets the current site classification + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPSite -DisableFlows + + Disables Flows for this site + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPSite -DisableFlows:$false + + Enables Flows for this site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSiteClosure + + Opens or closes a site which has a site policy applied + + + + + Set + PnPSiteClosure + + + + + Set-PnPSiteClosure + + State + + The state of the site + + ClosureState + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + State + + The state of the site + + ClosureState + + ClosureState + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSiteClosure -State Open + + This opens a site which has been closed and has a site policy applied. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPSiteClosure -State Closed + + This closes a site which is open and has a site policy applied. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSiteDesign + + * Supported in: SharePoint Online. + +Updates a Site Design on the current tenant. + + + + + Set + PnPSiteDesign + + + + + Set-PnPSiteDesign + + Identity + + The guid or an object representing the site design + + TenantSiteDesignPipeBind + + + Title + + The title of the site design + + String + + + SiteScriptIds + + An array of guids of site scripts + + GuidPipeBind[] + + + Description + + The description of the site design + + String + + + IsDefault + + Specifies if the site design is a default site design + + SwitchParameter + + + PreviewImageAltText + + Sets the text for the preview image + + String + + + PreviewImageUrl + + Sets the url to the preview image + + String + + + WebTemplate + + Specifies the type of site to which this design applies + + SiteWebTemplate + + + Version + + Specifies the version of the design + + Int32 + + + 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. + + SPOnlineConnection + + + + + + Description + + The description of the site design + + String + + String + + + + + Identity + + The guid or an object representing the site design + + TenantSiteDesignPipeBind + + TenantSiteDesignPipeBind + + + + + IsDefault + + Specifies if the site design is a default site design + + SwitchParameter + + SwitchParameter + + + + + PreviewImageAltText + + Sets the text for the preview image + + String + + String + + + + + PreviewImageUrl + + Sets the url to the preview image + + String + + String + + + + + SiteScriptIds + + An array of guids of site scripts + + GuidPipeBind[] + + GuidPipeBind[] + + + + + Title + + The title of the site design + + String + + String + + + + + Version + + Specifies the version of the design + + Int32 + + Int32 + + + + + WebTemplate + + Specifies the type of site to which this design applies + + SiteWebTemplate + + SiteWebTemplate + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e -Title "My Updated Company Design" + + Updates an existing Site Design and sets a new title. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $design = Get-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e +PS:> Set-PnPSiteDesign -Identity $design -Title "My Updated Company Design" + + Updates an existing Site Design and sets a new title. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPSiteScript + + * Supported in: SharePoint Online. + +Updates an existing Site Script on the current tenant. + + + + + Set + PnPSiteScript + + + + + Set-PnPSiteScript + + Identity + + The guid or an object representing the site script + + TenantSiteScriptPipeBind + + + Title + + The title of the site script + + String + + + Description + + The description of the site script + + String + + + Content + + A JSON string containing the site script + + String + + + Version + + Specifies the version of the site script + + Int32 + + + 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. + + SPOnlineConnection + + + + + + Content + + A JSON string containing the site script + + String + + String + + + + + Description + + The description of the site script + + String + + String + + + + + Identity + + The guid or an object representing the site script + + TenantSiteScriptPipeBind + + TenantSiteScriptPipeBind + + + + + Title + + The title of the site script + + String + + String + + + + + Version + + Specifies the version of the site script + + Int32 + + Int32 + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f -Title "My Site Script" + + Updates an existing Site Script and changes the title. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> $script = Get-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f +PS:> Set-PnPSiteScript -Identity $script -Title "My Site Script" + + Updates an existing Site Script and changes the title. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTaxonomyFieldValue + + Sets a taxonomy term value in a listitem field + + + + + Set + PnPTaxonomyFieldValue + + + + + Set-PnPTaxonomyFieldValue + + ListItem + + The list item to set the field value to + + ListItem + + + InternalFieldName + + The internal name of the field + + String + + + Terms + + Allows you to specify terms with key value pairs that can be referred to in the template by means of the {id:label} token. See examples on how to use this parameter. + + Hashtable + + + 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. + + SPOnlineConnection + + + + Set-PnPTaxonomyFieldValue + + TermId + + The Id of the Term + + GuidPipeBind + + + ListItem + + The list item to set the field value to + + ListItem + + + InternalFieldName + + The internal name of the field + + String + + + Label + + The Label value of the term + + String + + + 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. + + SPOnlineConnection + + + + Set-PnPTaxonomyFieldValue + + TermPath + + A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + + ListItem + + The list item to set the field value to + + ListItem + + + InternalFieldName + + The internal name of the field + + String + + + 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. + + SPOnlineConnection + + + + + + InternalFieldName + + The internal name of the field + + String + + String + + + + + Label + + The Label value of the term + + String + + String + + + + + ListItem + + The list item to set the field value to + + ListItem + + ListItem + + + + + TermId + + The Id of the Term + + GuidPipeBind + + GuidPipeBind + + + + + TermPath + + A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL + + String + + String + + + + + Terms + + Allows you to specify terms with key value pairs that can be referred to in the template by means of the {id:label} token. See examples on how to use this parameter. + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermId 863b832b-6818-4e6a-966d-2d3ee057931c + + Sets the field called 'Department' to the value of the term with the ID specified + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermPath 'CORPORATE|DEPARTMENTS|HR' + + Sets the field called 'Department' to the term called HR which is located in the DEPARTMENTS termset, which in turn is located in the CORPORATE termgroup. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -Terms @{"TermId1"="Label1";"TermId2"="Label2"} + + Sets the field called 'Department' with multiple terms by ID and label. You can refer to those terms with the {ID:label} token. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTenant + + * Supported in: SharePoint Online. + +Returns organization-level site collection properties + + + + + Set + PnPTenant + + + + Returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, +ResourceQuotaAllocated, and SiteCreationMode. + +Currently, there are no parameters for this cmdlet. + +You must be a SharePoint Online global administrator to run the cmdlet. + + + + Set-PnPTenant + + MinCompatibilityLevel + + Specifies the lower bound on the compatibility level for new sites. + + Int32 + + + MaxCompatibilityLevel + + Specifies the upper bound on the compatibility level for new sites. + + Int32 + + + ExternalServicesEnabled + + Enables external services for a tenant. +External services are defined as services that are not in the Office 365 datacenters. + +The valid values are: +True (default) - External services are enabled for the tenant. +False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. + + Boolean + + + NoAccessRedirectUrl + + Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess" + +The valid values are: +""(default) - Blank by default, this will also remove or clear any value that has been set. +Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx + + String + + + SharingCapability + + Determines what level of sharing is available for the site. + +The valid values are: +ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. +ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. + +For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). + + SharingCapabilities + + + DisplayStartASiteOption + + Determines whether tenant users see the Start a Site menu option. + +The valid values are: +True (default) - Tenant users will see the Start a Site menu option. +False - Start a Site is hidden from the menu. + + Boolean + + + StartASiteFormUrl + + Specifies URL of the form to load in the Start a Site dialog. + +The valid values are: +"" (default) - Blank by default, this will also remove or clear any value that has been set. +Full URL - Example: "https://contoso.sharepoint.com/path/to/form" + + String + + + ShowEveryoneClaim + + Enables the administrator to hide the Everyone claim in the People Picker. +When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. + +Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. + +The valid values are: +True (default) - The Everyone claim group is displayed in People Picker. +False - The Everyone claim group is hidden from the People Picker. + + Boolean + + + ShowAllUsersClaim + + Enables the administrator to hide the All Users claim groups in People Picker. + +When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organtization members in the tenant that used NTLM to authentication with SharePoint. + +Note, the All Users(authenticated) group is equivalent to the Everyone claim, and shows as Everyone.To change this, see - ShowEveryoneClaim. + +The valid values are: +True(default) - The All Users claim groups are displayed in People Picker. +False - The All Users claim groups are hidden in People Picker. + + Boolean + + + ShowEveryoneExceptExternalUsersClaim + + Enables the administrator to hide the "Everyone except external users" claim in the People Picker. +When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. + +The valid values are: +True(default) - The Everyone except external users is displayed in People Picker. +False - The Everyone except external users claim is not visible in People Picker. + + Boolean + + + SearchResolveExactEmailOrUPN + + Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. + +SharePoint Administrators will still be able to use starts with or partial name matching when enabled. + +The valid values are: +False (default) - Starts with / partial name search functionality is available. +True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins. + + Boolean + + + OfficeClientADALDisabled + + When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. + +The valid values are: +False (default) - Modern Authentication is enabled/allowed. +True - Modern Authentication via ADAL is disabled. + + Boolean + + + LegacyAuthProtocolsEnabled + + By default this value is set to $true. + +Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +A value of $true - Enables Office clients using non-modern authentication protocols(such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. + +A value of $false - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +Note: +This may also prevent third-party apps from accessing SharePoint Online resources.Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources.For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class. + + Boolean + + + RequireAcceptingAccountMatchInvitedAccount + + Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. + +Administrators who desire increased control over external collaborators should consider enabling this feature. + +Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. + +The valid values are: +False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. +True - User must accept this invitation with bob@contoso.com. + + Boolean + + + ProvisionSharedWithEveryoneFolder + + Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. + +The valid values are: +True (default) - The Shared with Everyone folder is created. +False - No folder is created when the site and OneDrive for Business document library is created. + +The default behavior of the Shared with Everyone folder changed in August 2015. +For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US) + + Boolean + + + SignInAccelerationDomain + + Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. + +When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. +This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. + +Acceleration will not occur on site collections that are shared externally. + +This value should be configured with the login domain that is used by your company (that is, example@contoso.com). + +If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. + +The valid values are: +"" (default) - Blank by default, this will also remove or clear any value that has been set. +Login Domain - For example: "contoso.com" + + String + + + EnableGuestSignInAcceleration + + Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. + +Note: +If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. + + Boolean + + + UsePersistentCookiesForExplorerView + + Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. + +"Open with Explorer" requires persisted cookies to operate correctly. +When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. + +This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. + +The valid values are: +False(default) - No special cookie is generated and the normal Office 365 sign -in length / timing applies. +True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in. + + Boolean + + + BccExternalSharingInvitations + + When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. + +The valid values are: +False (default) - BCC for external sharing is disabled. +True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. + + Boolean + + + BccExternalSharingInvitationsList + + Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. +Multiple addresses can be specified by creating a comma separated list with no spaces. + +The valid values are: +"" (default) - Blank by default, this will also clear any value that has been set. +Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com + + String + + + UserVoiceForFeedbackEnabled + + + + Boolean + + + PublicCdnEnabled + + + + Boolean + + + PublicCdnAllowedFileTypes + + + + String + + + RequireAnonymousLinksExpireInDays + + Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . + +To remove the expiration requirement, set the value to zero (0). + + Int32 + + + SharingAllowedDomainList + + Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business + + String + + + SharingBlockedDomainList + + Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business + + String + + + SharingDomainRestrictionMode + + Specifies the external sharing mode for domains. + +The following values are: None AllowList BlockList + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. + + SharingDomainRestrictionModes + + + OneDriveStorageQuota + + Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. + +A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. + +If value is set to 0, the parameter will have no effect. + +If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. + + Int64 + + + OneDriveForGuestsEnabled + + Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. + +The valid values are the following: + +$true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. + +$false- Administrator managed Guest users can't be given OneDrives as functionality is turned off. + + Boolean + + + IPAddressEnforcement + + Allows access from network locations that are defined by an administrator. + +The values are $true and $false. The default value is $false which means the setting is disabled. + +Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. + + Boolean + + + IPAddressAllowList + + Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). + +Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. + +Note: +The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. + + String + + + IPAddressWACTokenLifetime + + + + Int32 + + + UseFindPeopleInPeoplePicker + + Note: +When set to $true, users aren't able to share with security groups or SharePoint groups. + + Boolean + + + DefaultSharingLinkType + + Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. + +For additional information about how to change the default link type, see Change the default link type when users get links for sharing. + +Note: +Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. + +The values are: None Direct Internal AnonymousAccess + + SharingLinkType + + + ODBMembersCanShare + + Lets administrators set policy on re-sharing behavior in OneDrive for Business. + +Values: + +On- Users with edit permissions can re-share. + +Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. + +Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. + + SharingState + + + ODBAccessRequests + + Lets administrators set policy on access requests and requests to share in OneDrive for Business. + +Values: + +On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. + +Off- Prevent access requests and requests to share on OneDrive for Business. + +Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. + + SharingState + + + PreventExternalUsersFromResharing + + + + Boolean + + + ShowPeoplePickerSuggestionsForGuestUsers + + + + Boolean + + + FileAnonymousLinkType + + + + AnonymousLinkType + + + FolderAnonymousLinkType + + + + AnonymousLinkType + + + NotifyOwnersWhenItemsReshared + + When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. + +For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. + +The values are $true and $false. + + Boolean + + + NotifyOwnersWhenInvitationsAccepted + + When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. + +For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. + +The values are $true and $false. + + Boolean + + + NotificationsInOneDriveForBusinessEnabled + + + + Boolean + + + NotificationsInSharePointEnabled + + + + Boolean + + + OwnerAnonymousNotification + + + + Boolean + + + CommentsOnSitePagesDisabled + + + + Boolean + + + SocialBarOnSitePagesDisabled + + + + Boolean + + + OrphanedPersonalSitesRetentionPeriod + + Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. + +The value range is in days, between 30 and 3650. The default value is 30. + + Int32 + + + DisallowInfectedFileDownload + + Prevents the Download button from being displayed on the Virus Found warning page. + +Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. + + + + Boolean + + + DefaultLinkPermission + + + + SharingPermissionType + + + ConditionalAccessPolicy + + + + SPOConditionalAccessPolicyType + + + AllowDownloadingNonWebViewableFiles + + + + Boolean + + + AllowEditing + + + + Boolean + + + ApplyAppEnforcedRestrictionsToAdHocRecipients + + + + Boolean + + + FilePickerExternalImageSearchEnabled + + + + Boolean + + + EmailAttestationRequired + + + + Boolean + + + EmailAttestationReAuthDays + + + + Int32 + + + HideDefaultThemes + + Defines if the default themes are visible or hidden + + Boolean + + + 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. + + SPOnlineConnection + + + + + + AllowDownloadingNonWebViewableFiles + + + + Boolean + + Boolean + + + + + AllowEditing + + + + Boolean + + Boolean + + + + + ApplyAppEnforcedRestrictionsToAdHocRecipients + + + + Boolean + + Boolean + + + + + BccExternalSharingInvitations + + When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. + +The valid values are: +False (default) - BCC for external sharing is disabled. +True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. + + Boolean + + Boolean + + + + + BccExternalSharingInvitationsList + + Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. +Multiple addresses can be specified by creating a comma separated list with no spaces. + +The valid values are: +"" (default) - Blank by default, this will also clear any value that has been set. +Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com + + String + + String + + + + + CommentsOnSitePagesDisabled + + + + Boolean + + Boolean + + + + + ConditionalAccessPolicy + + + + SPOConditionalAccessPolicyType + + SPOConditionalAccessPolicyType + + + + + DefaultLinkPermission + + + + SharingPermissionType + + SharingPermissionType + + + + + DefaultSharingLinkType + + Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. + +For additional information about how to change the default link type, see Change the default link type when users get links for sharing. + +Note: +Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. + +The values are: None Direct Internal AnonymousAccess + + SharingLinkType + + SharingLinkType + + + + + DisallowInfectedFileDownload + + Prevents the Download button from being displayed on the Virus Found warning page. + +Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. + + + + Boolean + + Boolean + + + + + DisplayStartASiteOption + + Determines whether tenant users see the Start a Site menu option. + +The valid values are: +True (default) - Tenant users will see the Start a Site menu option. +False - Start a Site is hidden from the menu. + + Boolean + + Boolean + + + + + EmailAttestationReAuthDays + + + + Int32 + + Int32 + + + + + EmailAttestationRequired + + + + Boolean + + Boolean + + + + + EnableGuestSignInAcceleration + + Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. + +Note: +If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. + + Boolean + + Boolean + + + + + ExternalServicesEnabled + + Enables external services for a tenant. +External services are defined as services that are not in the Office 365 datacenters. + +The valid values are: +True (default) - External services are enabled for the tenant. +False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. + + Boolean + + Boolean + + + + + FileAnonymousLinkType + + + + AnonymousLinkType + + AnonymousLinkType + + + + + FilePickerExternalImageSearchEnabled + + + + Boolean + + Boolean + + + + + FolderAnonymousLinkType + + + + AnonymousLinkType + + AnonymousLinkType + + + + + HideDefaultThemes + + Defines if the default themes are visible or hidden + + Boolean + + Boolean + + + + + IPAddressAllowList + + Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). + +Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. + +Note: +The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. + + String + + String + + + + + IPAddressEnforcement + + Allows access from network locations that are defined by an administrator. + +The values are $true and $false. The default value is $false which means the setting is disabled. + +Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. + + Boolean + + Boolean + + + + + IPAddressWACTokenLifetime + + + + Int32 + + Int32 + + + + + LegacyAuthProtocolsEnabled + + By default this value is set to $true. + +Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +A value of $true - Enables Office clients using non-modern authentication protocols(such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. + +A value of $false - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +Note: +This may also prevent third-party apps from accessing SharePoint Online resources.Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources.For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class. + + Boolean + + Boolean + + + + + MaxCompatibilityLevel + + Specifies the upper bound on the compatibility level for new sites. + + Int32 + + Int32 + + + + + MinCompatibilityLevel + + Specifies the lower bound on the compatibility level for new sites. + + Int32 + + Int32 + + + + + NoAccessRedirectUrl + + Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess" + +The valid values are: +""(default) - Blank by default, this will also remove or clear any value that has been set. +Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx + + String + + String + + + + + NotificationsInOneDriveForBusinessEnabled + + + + Boolean + + Boolean + + + + + NotificationsInSharePointEnabled + + + + Boolean + + Boolean + + + + + NotifyOwnersWhenInvitationsAccepted + + When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. + +For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. + +The values are $true and $false. + + Boolean + + Boolean + + + + + NotifyOwnersWhenItemsReshared + + When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. + +For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. + +The values are $true and $false. + + Boolean + + Boolean + + + + + ODBAccessRequests + + Lets administrators set policy on access requests and requests to share in OneDrive for Business. + +Values: + +On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. + +Off- Prevent access requests and requests to share on OneDrive for Business. + +Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. + + SharingState + + SharingState + + + + + ODBMembersCanShare + + Lets administrators set policy on re-sharing behavior in OneDrive for Business. + +Values: + +On- Users with edit permissions can re-share. + +Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. + +Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. + + SharingState + + SharingState + + + + + OfficeClientADALDisabled + + When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. + +The valid values are: +False (default) - Modern Authentication is enabled/allowed. +True - Modern Authentication via ADAL is disabled. + + Boolean + + Boolean + + + + + OneDriveForGuestsEnabled + + Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. + +The valid values are the following: + +$true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. + +$false- Administrator managed Guest users can't be given OneDrives as functionality is turned off. + + Boolean + + Boolean + + + + + OneDriveStorageQuota + + Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. + +A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. + +If value is set to 0, the parameter will have no effect. + +If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. + + Int64 + + Int64 + + + + + OrphanedPersonalSitesRetentionPeriod + + Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. + +The value range is in days, between 30 and 3650. The default value is 30. + + Int32 + + Int32 + + + + + OwnerAnonymousNotification + + + + Boolean + + Boolean + + + + + PreventExternalUsersFromResharing + + + + Boolean + + Boolean + + + + + ProvisionSharedWithEveryoneFolder + + Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. + +The valid values are: +True (default) - The Shared with Everyone folder is created. +False - No folder is created when the site and OneDrive for Business document library is created. + +The default behavior of the Shared with Everyone folder changed in August 2015. +For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US) + + Boolean + + Boolean + + + + + PublicCdnAllowedFileTypes + + + + String + + String + + + + + PublicCdnEnabled + + + + Boolean + + Boolean + + + + + RequireAcceptingAccountMatchInvitedAccount + + Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. + +Administrators who desire increased control over external collaborators should consider enabling this feature. + +Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. + +The valid values are: +False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. +True - User must accept this invitation with bob@contoso.com. + + Boolean + + Boolean + + + + + RequireAnonymousLinksExpireInDays + + Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . + +To remove the expiration requirement, set the value to zero (0). + + Int32 + + Int32 + + + + + SearchResolveExactEmailOrUPN + + Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. + +SharePoint Administrators will still be able to use starts with or partial name matching when enabled. + +The valid values are: +False (default) - Starts with / partial name search functionality is available. +True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins. + + Boolean + + Boolean + + + + + SharingAllowedDomainList + + Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business + + String + + String + + + + + SharingBlockedDomainList + + Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business + + String + + String + + + + + SharingCapability + + Determines what level of sharing is available for the site. + +The valid values are: +ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. +ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. + +For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). + + SharingCapabilities + + SharingCapabilities + + + + + SharingDomainRestrictionMode + + Specifies the external sharing mode for domains. + +The following values are: None AllowList BlockList + +For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. + + SharingDomainRestrictionModes + + SharingDomainRestrictionModes + + + + + ShowAllUsersClaim + + Enables the administrator to hide the All Users claim groups in People Picker. + +When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organtization members in the tenant that used NTLM to authentication with SharePoint. + +Note, the All Users(authenticated) group is equivalent to the Everyone claim, and shows as Everyone.To change this, see - ShowEveryoneClaim. + +The valid values are: +True(default) - The All Users claim groups are displayed in People Picker. +False - The All Users claim groups are hidden in People Picker. + + Boolean + + Boolean + + + + + ShowEveryoneClaim + + Enables the administrator to hide the Everyone claim in the People Picker. +When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. + +Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. + +The valid values are: +True (default) - The Everyone claim group is displayed in People Picker. +False - The Everyone claim group is hidden from the People Picker. + + Boolean + + Boolean + + + + + ShowEveryoneExceptExternalUsersClaim + + Enables the administrator to hide the "Everyone except external users" claim in the People Picker. +When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. + +The valid values are: +True(default) - The Everyone except external users is displayed in People Picker. +False - The Everyone except external users claim is not visible in People Picker. + + Boolean + + Boolean + + + + + ShowPeoplePickerSuggestionsForGuestUsers + + + + Boolean + + Boolean + + + + + SignInAccelerationDomain + + Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. + +When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. +This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. + +Acceleration will not occur on site collections that are shared externally. + +This value should be configured with the login domain that is used by your company (that is, example@contoso.com). + +If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. + +The valid values are: +"" (default) - Blank by default, this will also remove or clear any value that has been set. +Login Domain - For example: "contoso.com" + + String + + String + + + + + SocialBarOnSitePagesDisabled + + + + Boolean + + Boolean + + + + + StartASiteFormUrl + + Specifies URL of the form to load in the Start a Site dialog. + +The valid values are: +"" (default) - Blank by default, this will also remove or clear any value that has been set. +Full URL - Example: "https://contoso.sharepoint.com/path/to/form" + + String + + String + + + + + UseFindPeopleInPeoplePicker + + Note: +When set to $true, users aren't able to share with security groups or SharePoint groups. + + Boolean + + Boolean + + + + + UsePersistentCookiesForExplorerView + + Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. + +"Open with Explorer" requires persisted cookies to operate correctly. +When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. + +This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. + +The valid values are: +False(default) - No special cookie is generated and the normal Office 365 sign -in length / timing applies. +True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in. + + Boolean + + Boolean + + + + + UserVoiceForFeedbackEnabled + + + + Boolean + + Boolean + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTenantSite -Identity https://contoso.sharepoint.com/sites/team1 -LockState NoAccess +Set-PnPTenant -NoAcessRedirectUrl 'http://www.contoso.com' + + This example blocks access to https://contoso.sharepoint.com/sites/team1 and redirects traffic to http://www.contoso.com. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPTenant -ShowEveryoneExceptExternalUsersClaim $false + + This example hides the "Everyone Except External Users" claim in People Picker. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPTenant -ShowAllUsersClaim $false + + This example hides the "All Users" claim group in People Picker. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPTenant -UsePersistentCookiesForExplorerView $true + + This example enables the use of special persisted cookie for Open with Explorer. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTenantCdnEnabled + + * Supported in: SharePoint Online. + +Enables or disabled the public or private Office 365 Content Delivery Network (CDN). + + + + + Set + PnPTenantCdnEnabled + + + + Enables or disabled the public or private Office 365 Content Delivery Network (CDN). + + + + Set-PnPTenantCdnEnabled + + Enable + + Specify to enable or disable + + Boolean + + + CdnType + + The type of cdn to enable or disable + + CdnType + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The type of cdn to enable or disable + + CdnType + + CdnType + + + + + Enable + + Specify to enable or disable + + Boolean + + Boolean + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTenantCdnEnabled -CdnType Public -Enable $true + + This example sets the Public CDN enabled. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTenantCdnPolicy + + * Supported in: SharePoint Online. + +Sets the CDN Policies for the specified CDN (Public | Private). + + + + + Set + PnPTenantCdnPolicy + + + + Sets the CDN Policies for the specified CDN (Public | Private). + + + + Set-PnPTenantCdnPolicy + + CdnType + + The type of cdn to retrieve the policies from + + SPOTenantCdnType + + + PolicyType + + The type of the policy to set + + SPOTenantCdnPolicyType + + + PolicyValue + + The value of the policy to set + + String + + + 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. + + SPOnlineConnection + + + + + + CdnType + + The type of cdn to retrieve the policies from + + SPOTenantCdnType + + SPOTenantCdnType + + + + + PolicyType + + The type of the policy to set + + SPOTenantCdnPolicyType + + SPOTenantCdnPolicyType + + + + + PolicyValue + + The value of the policy to set + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF" + + This example sets the IncludeFileExtensions policy to the specified value. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTenantSite + + * Supported in: SharePoint Online. + +Set site information. + + + + + Set + PnPTenantSite + + + + Sets site properties for existing sites. + + + + Set-PnPTenantSite + + Url + + Specifies the URL of the site + + String + + + Title + + Specifies the title of the site + + String + + + Sharing + + Specifies what the sharing capablilites are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly + + SharingCapabilities + + + StorageMaximumLevel + + Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. + + Int64 + + + StorageWarningLevel + + Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter + + Int64 + + + UserCodeMaximumLevel + + Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. + + Double + + + UserCodeWarningLevel + + Specifies the warning level for the resource quota. This value must not exceed the value set for the UserCodeMaximumLevel parameter + + Double + + + AllowSelfServiceUpgrade + + Specifies if the site administrator can upgrade the site collection + + SwitchParameter + + + Owners + + Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. + + String + + + LockState + + Sets the lockstate of a site + + SiteLockState + + + NoScriptSite + + Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. + + SwitchParameter + + + Wait + + Wait for the operation to complete + + SwitchParameter + + + 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. + + SPOnlineConnection + + + + + + AllowSelfServiceUpgrade + + Specifies if the site administrator can upgrade the site collection + + SwitchParameter + + SwitchParameter + + + + + LockState + + Sets the lockstate of a site + + SiteLockState + + SiteLockState + + + + + NoScriptSite + + Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. + + SwitchParameter + + SwitchParameter + + + + + Owners + + Specifies owner(s) to add as site collection adminstrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. + + String + + String + + + + + Sharing + + Specifies what the sharing capablilites are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly + + SharingCapabilities + + SharingCapabilities + + + + + StorageMaximumLevel + + Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. + + Int64 + + Int64 + + + + + StorageWarningLevel + + Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter + + Int64 + + Int64 + + + + + Title + + Specifies the title of the site + + String + + String + + + + + Url + + Specifies the URL of the site + + String + + String + + + + + UserCodeMaximumLevel + + Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. + + Double + + Double + + + + + UserCodeWarningLevel + + Specifies the warning level for the resource quota. This value must not exceed the value set for the UserCodeMaximumLevel parameter + + Double + + Double + + + + + Wait + + Wait for the operation to complete + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -Sharing Disabled + + This will set the title of the site collection with the URL 'https://contoso.sharepoint.com' to 'Contoso Website' and disable sharing on this site collection. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -StorageWarningLevel 8000 -StorageMaximumLevel 10000 + + This will set the title of the site collection with the URL 'https://contoso.sharepoint.com' to 'Contoso Website', set the storage warning level to 8GB and set the storage maximum level to 10GB. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners "user@contoso.onmicrosoft.com" + + This will add user@contoso.onmicrosoft.com as an additional site collection owner at 'https://contoso.sharepoint.com/sites/sales'. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") + + This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners at 'https://contoso.sharepoint.com/sites/sales'. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -NoScriptSite:$false + + This will enable script support for the site 'https://contoso.sharepoint.com/sites/sales' if disabled. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTheme + + Sets the theme of the current web. + + + + + Set + PnPTheme + + + + Sets the theme of the current web, if any of the attributes is not set, that value will be set to null + + + + Set-PnPTheme + + ColorPaletteUrl + + Specifies the Color Palette Url based on the site or server relative url + + String + + + FontSchemeUrl + + Specifies the Font Scheme Url based on the site or server relative url + + String + + + BackgroundImageUrl + + Specifies the Background Image Url based on the site or server relative url + + String + + + ResetSubwebsToInherit + + Resets subwebs to inherit the theme from the rootweb + + SwitchParameter + + + UpdateRootWebOnly + + Updates only the rootweb, even if subwebs are set to inherit the theme. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + BackgroundImageUrl + + Specifies the Background Image Url based on the site or server relative url + + String + + String + + + + + ColorPaletteUrl + + Specifies the Color Palette Url based on the site or server relative url + + String + + String + + + + + FontSchemeUrl + + Specifies the Font Scheme Url based on the site or server relative url + + String + + String + + + + + ResetSubwebsToInherit + + Resets subwebs to inherit the theme from the rootweb + + SwitchParameter + + SwitchParameter + + + + + UpdateRootWebOnly + + Updates only the rootweb, even if subwebs are set to inherit the theme. + + SwitchParameter + + SwitchParameter + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTheme + + Removes the current theme and resets it to the default. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor + + + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png' + + + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png' -ResetSubwebsToInherit + + Sets the theme to the web, and updates all subwebs to inherit the theme from this web. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPTraceLog + + Turn log tracing on or off + + + + + Set + PnPTraceLog + + + + Defines if tracing should be turned on. PnP Core, which is the foundation of these cmdlets, uses the standard Trace functionality of .NET. With this cmdlet you can turn capturing of this trace to a log file on or off. Notice that basically only the Provisioning Engine writes to the tracelog which means that cmdlets related to the engine will produce output. + + + + Set-PnPTraceLog + + On + + Turn on tracing to log file + + SwitchParameter + + + LogFile + + The path and filename of the file to write the trace log to. + + String + + + Level + + The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'. + + LogLevel + + + Delimiter + + If specified the trace log entries will be delimited with this value. + + String + + + IndentSize + + Indents in the tracelog will be with this amount of characters. Defaults to 4. + + Int32 + + + AutoFlush + + Auto flush the trace log. Defaults to true. + + Boolean + + + + Set-PnPTraceLog + + Off + + Turn off tracing to log file. + + SwitchParameter + + + + + + AutoFlush + + Auto flush the trace log. Defaults to true. + + Boolean + + Boolean + + + + + Delimiter + + If specified the trace log entries will be delimited with this value. + + String + + String + + + + + IndentSize + + Indents in the tracelog will be with this amount of characters. Defaults to 4. + + Int32 + + Int32 + + + + + Level + + The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'. + + LogLevel + + LogLevel + + + + + LogFile + + The path and filename of the file to write the trace log to. + + String + + String + + + + + Off + + Turn off tracing to log file. + + SwitchParameter + + SwitchParameter + + + + + On + + Turn on tracing to log file + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt + + This turns on trace logging to the file 'traceoutput.txt' and will capture events of at least 'Information' level. + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug + + This turns on trace logging to the file 'traceoutput.txt' and will capture debug events. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug -Delimiter "," + + This turns on trace logging to the file 'traceoutput.txt' and will write the entries as comma separated. Debug events are captured. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPTraceLog -Off + + This turns off trace logging. It will flush any remaining messages to the log file. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPUnifiedGroup + + * Supported in: SharePoint Online. + +Sets Office 365 Group (aka Unified Group) properties + + + + + Set + PnPUnifiedGroup + + + + + Set-PnPUnifiedGroup + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + + DisplayName + + The DisplayName of the group to set. + + String + + + Description + + The Description of the group to set. + + String + + + Owners + + The array UPN values of owners to add to the group. + + String[] + + + Members + + The array UPN values of members to add to the group. + + String[] + + + IsPrivate + + Makes the group private when selected. + + SwitchParameter + + + GroupLogoPath + + The path to the logo file of to set. + + String + + + + + + Description + + The Description of the group to set. + + String + + String + + + + + DisplayName + + The DisplayName of the group to set. + + String + + String + + + + + GroupLogoPath + + The path to the logo file of to set. + + String + + String + + + + + Identity + + The Identity of the Office 365 Group. + + UnifiedGroupPipeBind + + UnifiedGroupPipeBind + + + + + IsPrivate + + Makes the group private when selected. + + SwitchParameter + + SwitchParameter + + + + + Members + + The array UPN values of members to add to the group. + + String[] + + String[] + + + + + Owners + + The array UPN values of owners to add to the group. + + String[] + + String[] + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPUnifiedGroup -Identity $group -DisplayName "My Displayname" + + Sets the display name of the group where $group is a Group entity + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPUnifiedGroup -Identity $groupId -Descriptions "My Description" -DisplayName "My DisplayName" + + Sets the display name and description of a group based upon its ID + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Set-PnPUnifiedGroup -Identity $group -GroupLogoPath ".\MyLogo.png" + + Sets a specific Office 365 Group logo. + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Set-PnPUnifiedGroup -Identity $group -IsPrivate:$false + + Sets a group to be Public if previously Private. + + + + + + + + + + ------------------EXAMPLE 5--------------------- + + + + PS:> Set-PnPUnifiedGroup -Identity $group -Owners demo@contoso.com + + Adds demo@contoso.com as an additional owner to the group. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPUserProfileProperty + + * Supported in: SharePoint Online. + +Office365 only: Uses the tenant API to retrieve site information. + +You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. + + + + + + Set + PnPUserProfileProperty + + + + Requires a connection to a SharePoint Tenant Admin site. + + + + Set-PnPUserProfileProperty + + Value + + The value to set in the case of a single value property + + String + + + Account + + The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com + + String + + + PropertyName + + The property to set, for instance SPS-Skills or SPS-Location + + String + + + 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. + + SPOnlineConnection + + + + Set-PnPUserProfileProperty + + Values + + The values set in the case of a multi value property, e.g. "Value 1","Value 2" + + String[] + + + Account + + The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com + + String + + + PropertyName + + The property to set, for instance SPS-Skills or SPS-Location + + String + + + 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. + + SPOnlineConnection + + + + + + Account + + The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com + + String + + String + + + + + PropertyName + + The property to set, for instance SPS-Skills or SPS-Location + + String + + String + + + + + Value + + The value to set in the case of a single value property + + String + + String + + + + + Values + + The values set in the case of a multi value property, e.g. "Value 1","Value 2" + + String[] + + String[] + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm' + + Sets the SPS-Location property for the user as specified by the Account parameter + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2' + + Sets the MyProperty multi value property for the user as specified by the Account parameter + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPView + + Change view properties + + + + + Set + PnPView + + + + Sets one or more properties of an existing view. + + + + Set-PnPView + + Identity + + The Id, Title or instance of the view + + ViewPipeBind + + + Values + + Hashtable of properties to update on the view. Use the syntax @{property1="value";property2="value"}. + + Hashtable + + + List + + The Id, Title or Url of the list + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Id, Title or instance of the view + + ViewPipeBind + + ViewPipeBind + + + + + List + + The Id, Title or Url of the list + + ListPipeBind + + ListPipeBind + + + + + Values + + Hashtable of properties to update on the view. Use the syntax @{property1="value";property2="value"}. + + Hashtable + + Hashtable + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + Microsoft.SharePoint.Client.Field + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPView -List "Tasks" -Identity "All Tasks" -Values @{JSLink="hierarchytaskslist.js|customrendering.js";Title="My view"} + + Updates the "All Tasks" view on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to "My view" + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPList -Identity "Tasks" | Get-PnPView | Set-PnPView -Values @{JSLink="hierarchytaskslist.js|customrendering.js"} + + Updates all views on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWeb + + Sets properties on a web + + + + + Set + PnPWeb + + + + Sets properties on a web + + + + Set-PnPWeb + + SiteLogoUrl + + + + String + + + AlternateCssUrl + + + + String + + + Title + + + + String + + + Description + + + + String + + + MasterUrl + + + + String + + + CustomMasterUrl + + + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AlternateCssUrl + + + + String + + String + + + + + CustomMasterUrl + + + + String + + String + + + + + Description + + + + String + + String + + + + + MasterUrl + + + + String + + String + + + + + SiteLogoUrl + + + + String + + String + + + + + Title + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWebhookSubscription + + * Supported in: SharePoint Online. + +Updates a Webhook subscription + + + + + Set + PnPWebhookSubscription + + + + + Set-PnPWebhookSubscription + + Subscription + + The identity of the Webhook subscription to update + + WebhookSubscriptionPipeBind + + + List + + The list object or name from which the Webhook subscription will be modified + + ListPipeBind + + + NotificationUrl + + The URL of the Webhook endpoint that will be notified of the change + + String + + + ExpirationDate + + The date at which the Webhook subscription will expire. (Default: 6 months from today) + + DateTime + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ExpirationDate + + The date at which the Webhook subscription will expire. (Default: 6 months from today) + + DateTime + + DateTime + + + + + List + + The list object or name from which the Webhook subscription will be modified + + ListPipeBind + + ListPipeBind + + + + + NotificationUrl + + The URL of the Webhook endpoint that will be notified of the change + + String + + String + + + + + Subscription + + The identity of the Webhook subscription to update + + WebhookSubscriptionPipeBind + + WebhookSubscriptionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + OfficeDevPnP.Core.Entities.WebhookSubscription + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook + + Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" + + Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url and a new expiration date + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList +PS:> $updated = $subscriptions[0] +PS:> $updated.ExpirationDate = "2017-10-01" +PS:> Set-PnPWebhookSubscription -List MyList -Subscription $updated + + Updates the Webhook subscription from the list MyList with a modified subscription object. +Note: The date will be converted to Universal Time + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWebPartProperty + + Sets a web part property + + + + + Set + PnPWebPartProperty + + + + + Set-PnPWebPartProperty + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + + Identity + + The Guid of the webpart + + GuidPipeBind + + + Key + + Name of a single property to be set + + String + + + Value + + Value of the property to be set + + PSObject + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The Guid of the webpart + + GuidPipeBind + + GuidPipeBind + + + + + Key + + Name of a single property to be set + + String + + String + + + + + ServerRelativePageUrl + + Full server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx + + String + + String + + + + + Value + + Value of the property to be set + + PSObject + + PSObject + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title" + + Sets the title property of the webpart. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWebPermission + + Set permissions + + + + + Set + PnPWebPermission + + + + Sets web permissions + + + + Set-PnPWebPermission + + Group + + + + GroupPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWebPermission + + User + + + + String + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWebPermission + + Identity + + Identity/Id/Web object + + WebPipeBind + + + Group + + + + GroupPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWebPermission + + Identity + + Identity/Id/Web object + + WebPipeBind + + + User + + + + String + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWebPermission + + Url + + The site relative url of the web, e.g. 'Subweb1' + + String + + + Group + + + + GroupPipeBind + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWebPermission + + Url + + The site relative url of the web, e.g. 'Subweb1' + + String + + + User + + + + String + + + AddRole + + The role that must be assigned to the group or user + + String[] + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + AddRole + + The role that must be assigned to the group or user + + String[] + + String[] + + + + + Group + + + + GroupPipeBind + + GroupPipeBind + + + + + Identity + + Identity/Id/Web object + + WebPipeBind + + WebPipeBind + + + + + RemoveRole + + The role that must be removed from the group or user + + String[] + + String[] + + + + + Url + + The site relative url of the web, e.g. 'Subweb1' + + String + + String + + + + + User + + + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPWebPermission -Url projectA -User 'user@contoso.com' -AddRole 'Contribute' + + Adds the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its site relative url + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Set-PnPWebPermission -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 -User 'user@contoso.com' -RemoveRole 'Contribute' + + Removes the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its ID + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWebTheme + + * Supported in: SharePoint Online. + +Sets the theme of the current web. + + + + + Set + PnPWebTheme + + + + Sets the theme of the current web. * Requires Tenant Administration Rights * + + + + Set-PnPWebTheme + + WebUrl + + The URL of the web to apply the theme to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. + + String + + + Theme + + Specifies the Color Palette Url based on the site or server relative url + + ThemePipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Theme + + Specifies the Color Palette Url based on the site or server relative url + + ThemePipeBind + + ThemePipeBind + + + + + WebUrl + + The URL of the web to apply the theme to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline. + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Set-PnPWebTheme -Theme MyTheme + + Sets the theme named "MyTheme" to the current web + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Get-PnPTenantTheme -Name "MyTheme" | Set-PnPTheme + + Sets the theme named "MyTheme" to the current web + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Set-PnPWikiPageContent + + Sets the contents of a wikipage + + + + + Set + PnPWikiPageContent + + + + + Set-PnPWikiPageContent + + Content + + + + String + + + ServerRelativePageUrl + + Site Relative Page Url + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Set-PnPWikiPageContent + + Path + + + + String + + + ServerRelativePageUrl + + Site Relative Page Url + + String + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Content + + + + String + + String + + + + + Path + + + + String + + String + + + + + ServerRelativePageUrl + + Site Relative Page Url + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Copy-PnPItemProxy + + Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider + + + + + Copy + PnPItemProxy + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Move-PnPItemProxy + + Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider + + + + + Move + PnPItemProxy + + + + + + + + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Start-PnPWorkflowInstance + + Starts a workflow instance on a list item + + + + + Start + PnPWorkflowInstance + + + + + Start-PnPWorkflowInstance + + Subscription + + The workflow subscription to start + + WorkflowSubscriptionPipeBind + + + ListItem + + The list item to start the workflow against + + ListItemPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + ListItem + + The list item to start the workflow against + + ListItemPipeBind + + ListItemPipeBind + + + + + Subscription + + The workflow subscription to start + + WorkflowSubscriptionPipeBind + + WorkflowSubscriptionPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem $item + + Starts a workflow instance on the specified list item + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem 2 + + Starts a workflow instance on the specified list item + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Stop-PnPWorkflowInstance + + Stops a workflow instance + + + + + Stop + PnPWorkflowInstance + + + + + Stop-PnPWorkflowInstance + + Identity + + The instance to stop + + WorkflowInstancePipeBind + + + Force + + Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants. + + SwitchParameter + + SwitchParameter + + + + + Identity + + The instance to stop + + WorkflowInstancePipeBind + + WorkflowInstancePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Stop-PnPWorkflowInstance -identity $wfInstance + + Stops the workflow Instance + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Submit-PnPSearchQuery + + Executes an arbitrary search query against the SharePoint search index + + + + + Submit + PnPSearchQuery + + + + + Submit-PnPSearchQuery + + Query + + Search query in Keyword Query Language (KQL). + + String + + + StartRow + + Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. + + Int32 + + + MaxResults + + Maximum amount of search results to return. Default and max per page is 500 search results. + + Int32 + + + TrimDuplicates + + Specifies whether near duplicate items should be removed from the search results. + + Boolean + + + Properties + + Extra query properties. Can for example be used for Office Graph queries. + + Hashtable + + + Refiners + + The list of refiners to be returned in a search result. + + String + + + Culture + + The locale for the query. + + Int32 + + + QueryTemplate + + Specifies the query template that is used at run time to transform the query based on user input. + + String + + + SelectProperties + + The list of properties to return in the search results. + + String[] + + + RefinementFilters + + The set of refinement filters used. + + String[] + + + SortList + + The list of properties by which the search results are ordered. + + Hashtable + + + RankingModelId + + The identifier (ID) of the ranking model to use for the query. + + String + + + ClientType + + Specifies the name of the client which issued the query. + + String + + + HiddenConstraints + + The keyword query’s hidden constraints. + + String + + + TimeZoneId + + The identifier for the search query time zone. + + Int32 + + + EnablePhonetic + + Specifies whether the phonetic forms of the query terms are used to find matches. + + Boolean + + + EnableStemming + + Specifies whether stemming is enabled. + + Boolean + + + EnableQueryRules + + Specifies whether Query Rules are enabled for this query. + + Boolean + + + SourceId + + Specifies the identifier (ID or name) of the result source to be used to run the query. + + Guid + + + ProcessBestBets + + Determines whether Best Bets are enabled. + + Boolean + + + ProcessPersonalFavorites + + Determines whether personal favorites data is processed or not. + + Boolean + + + RelevantResults + + Specifies whether only relevant results are returned + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + Submit-PnPSearchQuery + + Query + + Search query in Keyword Query Language (KQL). + + String + + + All + + Automatically page results until the end to get more than 500. Use with caution! + + SwitchParameter + + + TrimDuplicates + + Specifies whether near duplicate items should be removed from the search results. + + Boolean + + + Properties + + Extra query properties. Can for example be used for Office Graph queries. + + Hashtable + + + Refiners + + The list of refiners to be returned in a search result. + + String + + + Culture + + The locale for the query. + + Int32 + + + QueryTemplate + + Specifies the query template that is used at run time to transform the query based on user input. + + String + + + SelectProperties + + The list of properties to return in the search results. + + String[] + + + RefinementFilters + + The set of refinement filters used. + + String[] + + + SortList + + The list of properties by which the search results are ordered. + + Hashtable + + + RankingModelId + + The identifier (ID) of the ranking model to use for the query. + + String + + + ClientType + + Specifies the name of the client which issued the query. + + String + + + HiddenConstraints + + The keyword query’s hidden constraints. + + String + + + TimeZoneId + + The identifier for the search query time zone. + + Int32 + + + EnablePhonetic + + Specifies whether the phonetic forms of the query terms are used to find matches. + + Boolean + + + EnableStemming + + Specifies whether stemming is enabled. + + Boolean + + + EnableQueryRules + + Specifies whether Query Rules are enabled for this query. + + Boolean + + + SourceId + + Specifies the identifier (ID or name) of the result source to be used to run the query. + + Guid + + + ProcessBestBets + + Determines whether Best Bets are enabled. + + Boolean + + + ProcessPersonalFavorites + + Determines whether personal favorites data is processed or not. + + Boolean + + + RelevantResults + + Specifies whether only relevant results are returned + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + All + + Automatically page results until the end to get more than 500. Use with caution! + + SwitchParameter + + SwitchParameter + + + + + ClientType + + Specifies the name of the client which issued the query. + + String + + String + + + + + Culture + + The locale for the query. + + Int32 + + Int32 + + + + + EnablePhonetic + + Specifies whether the phonetic forms of the query terms are used to find matches. + + Boolean + + Boolean + + + + + EnableQueryRules + + Specifies whether Query Rules are enabled for this query. + + Boolean + + Boolean + + + + + EnableStemming + + Specifies whether stemming is enabled. + + Boolean + + Boolean + + + + + HiddenConstraints + + The keyword query’s hidden constraints. + + String + + String + + + + + MaxResults + + Maximum amount of search results to return. Default and max per page is 500 search results. + + Int32 + + Int32 + + + + + ProcessBestBets + + Determines whether Best Bets are enabled. + + Boolean + + Boolean + + + + + ProcessPersonalFavorites + + Determines whether personal favorites data is processed or not. + + Boolean + + Boolean + + + + + Properties + + Extra query properties. Can for example be used for Office Graph queries. + + Hashtable + + Hashtable + + + + + Query + + Search query in Keyword Query Language (KQL). + + String + + String + + + + + QueryTemplate + + Specifies the query template that is used at run time to transform the query based on user input. + + String + + String + + + + + RankingModelId + + The identifier (ID) of the ranking model to use for the query. + + String + + String + + + + + RefinementFilters + + The set of refinement filters used. + + String[] + + String[] + + + + + Refiners + + The list of refiners to be returned in a search result. + + String + + String + + + + + RelevantResults + + Specifies whether only relevant results are returned + + SwitchParameter + + SwitchParameter + + + + + SelectProperties + + The list of properties to return in the search results. + + String[] + + String[] + + + + + SortList + + The list of properties by which the search results are ordered. + + Hashtable + + Hashtable + + + + + SourceId + + Specifies the identifier (ID or name) of the result source to be used to run the query. + + Guid + + Guid + + + + + StartRow + + Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results. + + Int32 + + Int32 + + + + + TimeZoneId + + The identifier for the search query time zone. + + Int32 + + Int32 + + + + + TrimDuplicates + + Specifies whether near duplicate items should be removed from the search results. + + Boolean + + Boolean + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + List<System.Object> + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Submit-PnPSearchQuery -Query "finance" + + Returns the top 500 items with the term finance + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -MaxResults 10 + + Returns the top 10 items indexed by SharePoint Search of which the title starts with the word Intranet + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -All + + Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet + + + + + + + + + + ------------------EXAMPLE 4--------------------- + + + + PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -Refiners "contentclass,FileType(filter=6/0/*)" + + Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet, and return refiners for contentclass and FileType managed properties + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Test-PnPListItemIsRecord + + * Supported in: SharePoint Online. + +Checks if a list item is a record + + + + + Test + PnPListItemIsRecord + + + + + Test-PnPListItemIsRecord + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + The ID of the listitem, or actual ListItem object + + ListItemPipeBind + + ListItemPipeBind + + + + + List + + The ID, Title or Url of the list. + + ListPipeBind + + ListPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Test-PnPListItemAsRecord -List "Documents" -Identity 4 + + Returns true if the document in the documents library with id 4 is a record + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Uninstall-PnPApp + + Uninstalls an available add-in from the site + + + + + Uninstall + PnPApp + + + + + Uninstall-PnPApp + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Uninstall-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will uninstall the specified app from the current site. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Uninstall-PnPAppInstance + + Removes an app from a site + + + + + Uninstall + PnPAppInstance + + + + Removes an add-in/app that has been installed to a site. + + + + Uninstall-PnPAppInstance + + Identity + + Appinstance or Id of the addin to remove. + + AppPipeBind + + + Force + + Do not ask for confirmation. + + SwitchParameter + + + 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. + + WebPipeBind + + + 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. + + SPOnlineConnection + + + + + + Force + + Do not ask for confirmation. + + SwitchParameter + + SwitchParameter + + + + + Identity + + Appinstance or Id of the addin to remove. + + AppPipeBind + + AppPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + 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. + + WebPipeBind + + WebPipeBind + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Uninstall-PnPAppInstance -Identity $appinstance + + Uninstalls the app instance which was retrieved with the command Get-PnPAppInstance + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -force + + Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' and do not ask for confirmation + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Uninstall-PnPSolution + + Uninstalls a sandboxed solution from a site collection + + + + + Uninstall + PnPSolution + + + + + Uninstall-PnPSolution + + PackageId + + ID of the solution, from the solution manifest + + GuidPipeBind + + + PackageName + + Filename of the WSP file to uninstall + + String + + + MajorVersion + + Optional major version of the solution, defaults to 1 + + Int32 + + + MinorVersion + + Optional minor version of the solution, defaults to 0 + + Int32 + + + 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. + + SPOnlineConnection + + + + + + MajorVersion + + Optional major version of the solution, defaults to 1 + + Int32 + + Int32 + + + + + MinorVersion + + Optional minor version of the solution, defaults to 0 + + Int32 + + Int32 + + + + + PackageId + + ID of the solution, from the solution manifest + + GuidPipeBind + + GuidPipeBind + + + + + PackageName + + Filename of the WSP file to uninstall + + String + + String + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Uninstall-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -SourceFilePath mypackage.wsp + + Removes the package to the current site + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Unpublish-PnPApp + + * Supported in: SharePoint Online. + +Unpublishes/retracts an available add-in from the app catalog + + + + + Unpublish + PnPApp + + + + + Unpublish-PnPApp + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id of the Addin Instance + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will retract, but not remove, the specified app from the app catalog + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Unregister-PnPHubSite + + * Supported in: SharePoint Online. + +Unregisters a site as a hubsite + + + + + Unregister + PnPHubSite + + + + Registers a site as a hubsite + + + + Unregister-PnPHubSite + + Site + + The site to unregister as a hubsite + + SitePipeBind + + + 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. + + SPOnlineConnection + + + + + + Site + + The site to unregister as a hubsite + + SitePipeBind + + SitePipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Unregister-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite + + This example unregisters the specified site as a hubsite + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Update-PnPApp + + * Supported in: SharePoint Online. + +Updates an available app from the app catalog + + + + + Update + PnPApp + + + + + Update-PnPApp + + Identity + + Specifies the Id or an actual app metadata instance + + AppMetadataPipeBind + + + 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. + + SPOnlineConnection + + + + + + Identity + + Specifies the Id or an actual app metadata instance + + AppMetadataPipeBind + + AppMetadataPipeBind + + + + + 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. + + SPOnlineConnection + + SPOnlineConnection + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe + + This will update an already installed app if a new version is available. Retrieve a list all available apps and the installed and available versions with Get-PnPApp + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + + + Update-PnPSiteClassification + + * Supported in: SharePoint Online. + +Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph. + + + + + Update + PnPSiteClassification + + + + + Update-PnPSiteClassification + + Classifications + + A list of classifications, separated by commas. E.g. "HBI","LBI","Top Secret" + + String + + + DefaultClassification + + The default classification to be used. The value needs to be present in the list of possible classifications + + String + + + UsageGuidelinesUrl + + The UsageGuidelinesUrl. Set to "" to clear. + + String + + + + Update-PnPSiteClassification + + Settings + + A settings object retrieved by Get-PnPSiteClassification + + SiteClassificationsSettings + + + + + + Classifications + + A list of classifications, separated by commas. E.g. "HBI","LBI","Top Secret" + + String + + String + + + + + DefaultClassification + + The default classification to be used. The value needs to be present in the list of possible classifications + + String + + String + + + + + Settings + + A settings object retrieved by Get-PnPSiteClassification + + SiteClassificationsSettings + + SiteClassificationsSettings + + + + + UsageGuidelinesUrl + + The UsageGuidelinesUrl. Set to "" to clear. + + String + + String + + + + + + + + + + + + + + + + + + ------------------EXAMPLE 1--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Update-PnPSiteClassification -Classifications "HBI","Top Secret" + + Replaces the existing values of the site classification settings + + + + + + + + + + ------------------EXAMPLE 2--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Update-PnPSiteClassification -DefaultClassification "LBI" + + Sets the default classification value to "LBI". This value needs to be present in the list of classification values. + + + + + + + + + + ------------------EXAMPLE 3--------------------- + + + + PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" +PS:> Update-PnPSiteClassification -UsageGuidelinesUrl http://aka.ms/sppnp + + sets the usage guideliness URL to the specified URL. + + + + + + + + + + + + SharePoint Developer Patterns and Practices: + http://aka.ms/sppnp + + + + \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnline.psd1 b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnline.psd1 new file mode 100644 index 00000000..6d039c50 --- /dev/null +++ b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnline.psd1 @@ -0,0 +1,21 @@ +@{ + RootModule = 'SharePointPnP.PowerShell.Online.Commands.dll' + ModuleVersion = '2.25.1804.0' + Description = 'SharePoint Patterns and Practices PowerShell Cmdlets for SharePoint Online' + GUID = '8f1147be-a8e4-4bd2-a705-841d5334edc0' + Author = 'SharePoint Patterns and Practices' + CompanyName = 'SharePoint Patterns and Practices' + DotNetFrameworkVersion = '4.5' + ProcessorArchitecture = 'None' + FunctionsToExport = '*' + CmdletsToExport = 'Add-PnPApp','Add-PnPClientSidePage','Add-PnPClientSidePageSection','Add-PnPClientSideText','Add-PnPClientSideWebPart','Add-PnPContentType','Add-PnPContentTypeToDocumentSet','Add-PnPContentTypeToList','Add-PnPCustomAction','Add-PnPDataRowsToProvisioningTemplate','Add-PnPDocumentSet','Add-PnPEventReceiver','Add-PnPField','Add-PnPFieldFromXml','Add-PnPFieldToContentType','Add-PnPFile','Add-PnPFileToProvisioningTemplate','Add-PnPFolder','Add-PnPHtmlPublishingPageLayout','Add-PnPHubSiteAssociation','Add-PnPIndexedProperty','Add-PnPJavaScriptBlock','Add-PnPJavaScriptLink','Add-PnPListFoldersToProvisioningTemplate','Add-PnPListItem','Add-PnPMasterPage','Add-PnPNavigationNode','Test-PnPOffice365GroupAliasIsUsed','Add-PnPOffice365GroupToSite','Add-PnPPublishingImageRendition','Add-PnPPublishingPage','Add-PnPPublishingPageLayout','Add-PnPRoleDefinition','Add-PnPSiteClassification','Add-PnPSiteCollectionAdmin','Add-PnPSiteCollectionAppCatalog','Add-PnPSiteDesign','Add-PnPSiteScript','Add-PnPStoredCredential','Add-PnPTaxonomyField','Add-PnPTenantCdnOrigin','Add-PnPTenantTheme','Add-PnPUserToGroup','Add-PnPView','Add-PnPWebhookSubscription','Add-PnPWebPartToWebPartPage','Add-PnPWebPartToWikiPage','Add-PnPWikiPage','Add-PnPWorkflowDefinition','Add-PnPWorkflowSubscription','Apply-PnPProvisioningTemplate','Set-PnPSitePolicy','Clear-PnPListItemAsRecord','Clear-PnPRecycleBinItem','Clear-PnPTenantRecycleBinItem','Connect-PnPOnline','Connect-PnPMicrosoftGraph','Convert-PnPProvisioningTemplate','Convert-PnPFolderToProvisioningTemplate','Copy-PnPFile','Disable-PnPFeature','Disable-PnPInPlaceRecordsManagementForSite','Disable-PnPResponsiveUI','Disable-PnPSiteClassification','Disconnect-PnPOnline','Enable-PnPFeature','Enable-PnPInPlaceRecordsManagementForSite','Enable-PnPResponsiveUI','Enable-PnPSiteClassification','Get-PnPProperty','Export-PnPTaxonomy','Export-PnPTermGroupToXml','Find-PnPFile','Get-PnPApp','Get-PnPAppInstance','Get-PnPAuditing','Get-PnPAuthenticationRealm','Get-PnPAvailableClientSideComponents','Get-PnPAzureADManifestKeyCredentials','Get-PnPClientSideComponent','Get-PnPClientSidePage','Get-PnPContentType','Get-PnPContentTypePublishingHubUrl','Get-PnPCustomAction','Get-PnPDefaultColumnValues','Get-PnPDocumentSetTemplate','Get-PnPEventReceiver','Get-PnPFeature','Get-PnPField','Get-PnPFile','Get-PnPFolder','Get-PnPFolderItem','Get-PnPGroup','Get-PnPGroupMembers','Get-PnPGroupPermissions','Get-PnPHealthScore','Get-PnPHideDefaultThemes','Get-PnPHomePage','Get-PnPHubSite','Get-PnPHubSiteNavigation','Get-PnPIndexedPropertyKeys','Get-PnPInPlaceRecordsManagement','Get-PnPJavaScriptLink','Get-PnPList','Get-PnPListInformationRightsManagement','Get-PnPListItem','Get-PnPListRecordDeclaration','Get-PnPMasterPage','Get-PnPNavigationNode','Get-PnPAccessToken','Get-PnPAzureCertificate','Get-PnPAppAuthAccessToken','Get-PnPConnection','Get-PnPSiteCollectionTermStore','Get-PnPStorageEntity','Get-PnPPropertyBag','Get-PnPProvisioningTemplate','Get-PnPProvisioningTemplateFromGallery','Get-PnPPublishingImageRendition','Get-PnPRecycleBinItem','Get-PnPRequestAccessEmails','Get-PnPRoleDefinition','Get-PnPSearchConfiguration','Get-PnPSite','Get-PnPSiteClassification','Get-PnPSiteClosure','Get-PnPSiteCollectionAdmin','Get-PnPSiteDesign','Get-PnPSiteDesignRights','Get-PnPSitePolicy','Get-PnPSiteScript','Get-PnPSiteSearchQueryResults','Get-PnPContext','Get-PnPStoredCredential','Get-PnPSubWebs','Get-PnPTaxonomyItem','Get-PnPTaxonomySession','Get-PnPTenant','Get-PnPTenantAppCatalogUrl','Get-PnPTenantCdnEnabled','Get-PnPTenantCdnOrigin','Get-PnPTenantCdnPolicies','Get-PnPTenantRecycleBinItem','Get-PnPTenantSite','Get-PnPTenantTheme','Get-PnPTerm','Get-PnPTermGroup','Get-PnPTermSet','Get-PnPTheme','Get-PnPTimeZoneId','Get-PnPUnifiedGroup','Get-PnPUnifiedGroupMembers','Get-PnPUnifiedGroupOwners','Get-PnPUser','Get-PnPUserProfileProperty','Get-PnPView','Get-PnPWeb','Get-PnPWebhookSubscriptions','Get-PnPWebPart','Get-PnPWebPartProperty','Get-PnPWebPartXml','Get-PnPWebTemplates','Get-PnPWikiPageContent','Get-PnPWorkflowDefinition','Get-PnPWorkflowInstance','Get-PnPWorkflowSubscription','Grant-PnPHubSiteRights','Grant-PnPSiteDesignRights','Import-PnPAppPackage','Import-PnPTaxonomy','Import-PnPTermGroupFromXml','Import-PnPTermSet','Install-PnPApp','Install-PnPSolution','Invoke-PnPQuery','Invoke-PnPSiteDesign','Invoke-PnPWebAction','Measure-PnPList','Measure-PnPWeb','Measure-PnPResponseTime','Move-PnPClientSideComponent','Move-PnPFile','Move-PnPFolder','Move-PnPListItemToRecycleBin','Move-PnPRecycleBinItem','New-PnPExtensibilityHandlerObject','New-PnPGroup','New-PnPList','New-PnPPersonalSite','New-PnPAzureCertificate','New-PnPUnifiedGroup','New-PnPProvisioningTemplate','New-PnPProvisioningTemplateFromFolder','New-PnPSite','New-PnPTenantSite','New-PnPTerm','New-PnPTermGroup','New-PnPTermSet','New-PnPUser','New-PnPWeb','Publish-PnPApp','Read-PnPProvisioningTemplate','Register-PnPHubSite','Remove-PnPApp','Remove-PnPClientSideComponent','Remove-PnPClientSidePage','Remove-PnPContentType','Remove-PnPContentTypeFromDocumentSet','Remove-PnPContentTypeFromList','Remove-PnPCustomAction','Remove-PnPIndexedProperty','Remove-PnPEventReceiver','Remove-PnPField','Remove-PnPFieldFromContentType','Remove-PnPFile','Remove-PnPFileFromProvisioningTemplate','Remove-PnPFolder','Remove-PnPGroup','Remove-PnPHubSiteAssociation','Remove-PnPJavaScriptLink','Remove-PnPList','Remove-PnPListItem','Remove-PnPNavigationNode','Remove-PnPStorageEntity','Remove-PnPPropertyBagValue','Remove-PnPPublishingImageRendition','Remove-PnPRoleDefinition','Remove-PnPTenantSite','Remove-PnPSiteClassification','Remove-PnPSiteCollectionAdmin','Remove-PnPSiteCollectionAppCatalog','Remove-PnPSiteDesign','Remove-PnPSiteScript','Remove-PnPStoredCredential','Remove-PnPTaxonomyItem','Remove-PnPTenantCdnOrigin','Remove-PnPTenantTheme','Remove-PnPTermGroup','Remove-PnPUnifiedGroup','Remove-PnPUser','Remove-PnPUserFromGroup','Remove-PnPView','Remove-PnPWeb','Remove-PnPWebhookSubscription','Remove-PnPWebPart','Remove-PnPWikiPage','Remove-PnPWorkflowDefinition','Remove-PnPWorkflowSubscription','Rename-PnPFile','Rename-PnPFolder','Request-PnPReIndexList','Request-PnPReIndexWeb','Resolve-PnPFolder','Restore-PnPRecycleBinItem','Restore-PnPTenantRecycleBinItem','Resume-PnPWorkflowInstance','Revoke-PnPSiteDesignRights','Save-PnPProvisioningTemplate','Send-PnPMail','Set-PnPAppSideLoading','Set-PnPAuditing','Set-PnPAvailablePageLayouts','Set-PnPClientSidePage','Set-PnPClientSideText','Set-PnPClientSideWebPart','Set-PnPContext','Set-PnPDefaultColumnValues','Set-PnPDefaultContentTypeToList','Set-PnPDefaultPageLayout','Set-PnPField','Set-PnPDocumentSetField','Set-PnPFileCheckedIn','Set-PnPFileCheckedOut','Set-PnPGroup','Set-PnPGroupPermissions','Set-PnPHideDefaultThemes','Set-PnPHomePage','Set-PnPHubSite','Set-PnPIndexedProperties','Set-PnPInPlaceRecordsManagement','Set-PnPList','Set-PnPListInformationRightsManagement','Set-PnPListItem','Set-PnPListItemAsRecord','Set-PnPListItemPermission','Set-PnPListPermission','Set-PnPListRecordDeclaration','Set-PnPMasterPage','Set-PnPMinimalDownloadStrategy','Set-PnPStorageEntity','Set-PnPPropertyBagValue','Set-PnPProvisioningTemplateMetadata','Set-PnPRequestAccessEmails','Set-PnPSearchConfiguration','Set-PnPSite','Set-PnPSiteClosure','Set-PnPSiteDesign','Set-PnPSiteScript','Set-PnPTaxonomyFieldValue','Set-PnPTenant','Set-PnPTenantCdnEnabled','Set-PnPTenantCdnPolicy','Set-PnPTenantSite','Set-PnPTheme','Set-PnPTraceLog','Set-PnPUnifiedGroup','Set-PnPUserProfileProperty','Set-PnPView','Set-PnPWeb','Set-PnPWebhookSubscription','Set-PnPWebPartProperty','Set-PnPWebPermission','Set-PnPWebTheme','Set-PnPWikiPageContent','Copy-PnPItemProxy','Move-PnPItemProxy','Start-PnPWorkflowInstance','Stop-PnPWorkflowInstance','Submit-PnPSearchQuery','Test-PnPListItemIsRecord','Uninstall-PnPApp','Uninstall-PnPAppInstance','Uninstall-PnPSolution','Unpublish-PnPApp','Unregister-PnPHubSite','Update-PnPApp','Update-PnPSiteClassification' + VariablesToExport = '*' + AliasesToExport = '*' + FormatsToProcess = 'SharePointPnP.PowerShell.Online.Commands.Format.ps1xml' + PrivateData = @{ + PSData = @{ + ProjectUri = 'https://aka.ms/sppnp' + IconUri = 'https://raw.githubusercontent.com/SharePoint/PnP-PowerShell/master/Commands/Resources/pnp.ico' + } + } +} \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnlineAliases.psm1 b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnlineAliases.psm1 new file mode 100644 index 00000000..4e8ba4e6 --- /dev/null +++ b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/SharePointPnPPowerShellOnlineAliases.psm1 @@ -0,0 +1 @@ +Set-Alias -Name New-PnPSiteCollection -Value New-PnPTenantSite diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.IdentityModel.Tokens.Jwt.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.IdentityModel.Tokens.Jwt.dll new file mode 100644 index 00000000..660b1657 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.IdentityModel.Tokens.Jwt.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Management.Automation.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Management.Automation.dll new file mode 100644 index 00000000..b6e5f946 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Management.Automation.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Net.Http.Formatting.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Net.Http.Formatting.dll new file mode 100644 index 00000000..3b76acd6 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Net.Http.Formatting.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Spatial.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Spatial.dll new file mode 100644 index 00000000..988f60e2 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Spatial.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Text.Encodings.Web.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Text.Encodings.Web.dll new file mode 100644 index 00000000..8f104e2f Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Text.Encodings.Web.dll differ diff --git a/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Web.Http.dll b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Web.Http.dll new file mode 100644 index 00000000..e1dbdd18 Binary files /dev/null and b/assets/functions/applyportaltemplate/modules/SharePointPnPPowerShellOnline/System.Web.Http.dll differ diff --git a/assets/functions/applyportaltemplate/portal.xml b/assets/functions/applyportaltemplate/portal.xml new file mode 100644 index 00000000..c2b9b902 --- /dev/null +++ b/assets/functions/applyportaltemplate/portal.xml @@ -0,0 +1,142 @@ + + + + Helsinki + SP Portal Showcase - Helsinki Style + MSFT + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 30 + clienttemplates.js + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/assets/functions/applyportaltemplate/run.ps1 b/assets/functions/applyportaltemplate/run.ps1 new file mode 100644 index 00000000..276b765d --- /dev/null +++ b/assets/functions/applyportaltemplate/run.ps1 @@ -0,0 +1,5 @@ +$in = Get-Content $triggerInput -Raw +Write-Output "Incoming request for '$in'" +Connect-PnPOnline -AppId $env:SPO_AppId -AppSecret $env:SPO_AppSecret -Url $in +Write-Output "Connected to site" +Apply-PnPProvisioningTemplate -Path D:\home\site\wwwroot\applyportaltemplate\portal.xml \ No newline at end of file diff --git a/assets/functions/host.json b/assets/functions/host.json new file mode 100644 index 00000000..189545a2 --- /dev/null +++ b/assets/functions/host.json @@ -0,0 +1 @@ +{"swagger":{"enabled":true}} \ No newline at end of file diff --git a/provisioning/Azure/functionapp.json b/provisioning/Azure/functionapp.json new file mode 100644 index 00000000..4435340f --- /dev/null +++ b/provisioning/Azure/functionapp.json @@ -0,0 +1,88 @@ +{ + "$schema":"http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion":"1.0.0.0", + "parameters":{ + "siteName":{ + "type":"string" + }, + "siteLocation":{ + "type":"string", + "defaultValue": "[resourceGroup().location]" + }, + "repoUrl": { + "type": "string" + }, + "branch": { + "type": "string", + "defaultValue": "master" + }, + "storageAccountName": { + "type": "string" + }, + "storageAccountid": { + "type": "string" + } + }, + "resources":[ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[parameters('storageAccountName')]", + "apiVersion": "2015-05-01-preview", + "location": "[parameters('siteLocation')]", + "properties": { + "accountType": "Standard_LRS" + } + }, + { + "apiVersion":"2016-03-01", + "name":"[parameters('siteName')]", + "type":"Microsoft.Web/sites", + "kind": "functionapp", + "location":"[parameters('siteLocation')]", + "dependsOn": [ + "[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]" + ], + "properties": { + "siteConfig": { + "appSettings": [ + { + "name": "AzureWebJobsDashboard", + "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', parameters('storageAccountName'), ';AccountKey=', listKeys(parameters('storageAccountid'),'2015-05-01-preview').key1)]" + }, + { + "name": "AzureWebJobsStorage", + "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', parameters('storageAccountName'), ';AccountKey=', listKeys(parameters('storageAccountid'),'2015-05-01-preview').key1)]" + }, + { + "name": "WEBSITE_CONTENTAZUREFILECONNECTIONSTRING", + "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', parameters('storageAccountName'), ';AccountKey=', listKeys(parameters('storageAccountid'),'2015-05-01-preview').key1)]" + }, + { + "name": "WEBSITE_CONTENTSHARE", + "value": "[toLower(parameters('siteName'))]" + }, + { + "name": "FUNCTIONS_EXTENSION_VERSION", + "value": "~1" + } + ] + } + }, + "resources": [ + { + "apiVersion": "2016-03-01", + "name": "web", + "type": "sourcecontrols", + "dependsOn": [ + "[resourceId('Microsoft.Web/Sites', parameters('siteName'))]" + ], + "properties": { + "RepoUrl": "[parameters('repoUrl')]", + "branch": "[parameters('branch')]", + "IsManualIntegration": true + } + } + ] + } + ] +} \ No newline at end of file diff --git a/provisioning/PnPSPPortalShowCase.json b/provisioning/PnPSPPortalShowCase.json new file mode 100644 index 00000000..956530a4 --- /dev/null +++ b/provisioning/PnPSPPortalShowCase.json @@ -0,0 +1,287 @@ +{ + "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "sites_pnpspportalshowcase_name": { + "defaultValue": null, + "type": "String" + }, + "serverfarms_pnpspportalshowcase_name": { + "defaultValue": null, + "type": "String" + }, + "config_web_name": { + "defaultValue": null, + "type": "String" + }, + "storageAccounts_pnpspportalshowcase_name": { + "defaultValue": null, + "type": "String" + }, + "deployments_63f65d721b622dcbc1787fd73b815144d80d8b23_name": { + "defaultValue": null, + "type": "String" + }, + "hostNameBindings_pnpspportalshowcase.azurewebsites.net_name": { + "defaultValue": null, + "type": "String" + } + }, + "variables": {}, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "kind": "Storage", + "name": "[parameters('storageAccounts_pnpspportalshowcase_name')]", + "apiVersion": "2017-10-01", + "location": "northeurope", + "tags": {}, + "scale": null, + "properties": { + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": false, + "encryption": { + "services": { + "file": { + "enabled": true + }, + "blob": { + "enabled": true + } + }, + "keySource": "Microsoft.Storage" + } + }, + "dependsOn": [] + }, + { + "type": "Microsoft.Web/serverfarms", + "sku": { + "name": "Y1", + "tier": "Dynamic", + "size": "Y1", + "family": "Y", + "capacity": 0 + }, + "kind": "functionapp", + "name": "[parameters('serverfarms_pnpspportalshowcase_name')]", + "apiVersion": "2016-09-01", + "location": "North Europe", + "scale": null, + "properties": { + "name": "[parameters('serverfarms_pnpspportalshowcase_name')]", + "workerTierName": null, + "adminSiteName": null, + "hostingEnvironmentProfile": null, + "perSiteScaling": false, + "reserved": false, + "targetWorkerCount": 0, + "targetWorkerSizeId": 0 + }, + "dependsOn": [] + }, + { + "type": "Microsoft.Web/sites", + "kind": "functionapp", + "name": "[parameters('sites_pnpspportalshowcase_name')]", + "apiVersion": "2016-08-01", + "location": "North Europe", + "scale": null, + "properties": { + "enabled": true, + "hostNameSslStates": [ + { + "name": "[concat(parameters('sites_pnpspportalshowcase_name'),'.azurewebsites.net')]", + "sslState": "Disabled", + "virtualIP": null, + "thumbprint": null, + "toUpdate": null, + "hostType": "Standard" + }, + { + "name": "[concat(parameters('sites_pnpspportalshowcase_name'),'.scm.azurewebsites.net')]", + "sslState": "Disabled", + "virtualIP": null, + "thumbprint": null, + "toUpdate": null, + "hostType": "Repository" + } + ], + "serverFarmId": "[resourceId('Microsoft.Web/serverfarms', parameters('serverfarms_pnpspportalshowcase_name'))]", + "reserved": false, + "siteConfig": null, + "scmSiteAlsoStopped": false, + "hostingEnvironmentProfile": null, + "clientAffinityEnabled": false, + "clientCertEnabled": false, + "hostNamesDisabled": false, + "containerSize": 1536, + "dailyMemoryTimeQuota": 0, + "cloningInfo": null + }, + "dependsOn": [ + "[resourceId('Microsoft.Web/serverfarms', parameters('serverfarms_pnpspportalshowcase_name'))]" + ] + }, + { + "type": "Microsoft.Web/sites/config", + "name": "[concat(parameters('sites_pnpspportalshowcase_name'), '/', parameters('config_web_name'))]", + "apiVersion": "2016-08-01", + "location": "North Europe", + "scale": null, + "properties": { + "numberOfWorkers": 1, + "defaultDocuments": [ + "Default.htm", + "Default.html", + "Default.asp", + "index.htm", + "index.html", + "iisstart.htm", + "default.aspx", + "index.php" + ], + "netFrameworkVersion": "v4.0", + "phpVersion": "5.6", + "pythonVersion": "", + "nodeVersion": "", + "linuxFxVersion": "", + "requestTracingEnabled": false, + "remoteDebuggingEnabled": false, + "remoteDebuggingVersion": null, + "httpLoggingEnabled": false, + "logsDirectorySizeLimit": 35, + "detailedErrorLoggingEnabled": false, + "publishingUsername": "$pnpspportalshowcase", + "publishingPassword": null, + "appSettings": null, + "metadata": null, + "connectionStrings": null, + "machineKey": null, + "handlerMappings": null, + "documentRoot": null, + "scmType": "GitHub", + "use32BitWorkerProcess": true, + "webSocketsEnabled": false, + "alwaysOn": false, + "javaVersion": null, + "javaContainer": null, + "javaContainerVersion": null, + "appCommandLine": "", + "managedPipelineMode": "Integrated", + "virtualApplications": [ + { + "virtualPath": "/", + "physicalPath": "site\\wwwroot", + "preloadEnabled": false, + "virtualDirectories": null + } + ], + "winAuthAdminState": 0, + "winAuthTenantState": 0, + "customAppPoolIdentityAdminState": false, + "customAppPoolIdentityTenantState": false, + "runtimeADUser": null, + "runtimeADUserPassword": null, + "loadBalancing": "LeastRequests", + "routingRules": [], + "experiments": { + "rampUpRules": [] + }, + "limits": null, + "autoHealEnabled": false, + "autoHealRules": null, + "tracingOptions": null, + "vnetName": "", + "siteAuthEnabled": false, + "siteAuthSettings": { + "enabled": null, + "unauthenticatedClientAction": null, + "tokenStoreEnabled": null, + "allowedExternalRedirectUrls": null, + "defaultProvider": null, + "clientId": null, + "clientSecret": null, + "issuer": null, + "allowedAudiences": null, + "additionalLoginParams": null, + "isAadAutoProvisioned": false, + "googleClientId": null, + "googleClientSecret": null, + "googleOAuthScopes": null, + "facebookAppId": null, + "facebookAppSecret": null, + "facebookOAuthScopes": null, + "twitterConsumerKey": null, + "twitterConsumerSecret": null, + "microsoftAccountClientId": null, + "microsoftAccountClientSecret": null, + "microsoftAccountOAuthScopes": null + }, + "cors": { + "allowedOrigins": [ + "https://functions.azure.com", + "https://functions-staging.azure.com", + "https://functions-next.azure.com" + ] + }, + "push": null, + "apiDefinition": null, + "autoSwapSlotName": null, + "localMySqlEnabled": false, + "managedServiceIdentityId": null, + "ipSecurityRestrictions": null, + "http20Enabled": true, + "minTlsVersion": "1.0" + }, + "dependsOn": [ + "[resourceId('Microsoft.Web/sites', parameters('sites_pnpspportalshowcase_name'))]" + ] + }, + { + "type": "Microsoft.Web/sites/deployments", + "name": "[concat(parameters('sites_pnpspportalshowcase_name'), '/', parameters('deployments_63f65d721b622dcbc1787fd73b815144d80d8b23_name'))]", + "apiVersion": "2016-08-01", + "location": "North Europe", + "scale": null, + "properties": { + "id": "[parameters('deployments_63f65d721b622dcbc1787fd73b815144d80d8b23_name')]", + "status": 4, + "author_email": "erwin.van.hunen@outlook.com", + "author": "Erwin van Hunen", + "deployer": "GitHub", + "message": "initial\n", + "start_time": "2018-04-05T11:14:24.8147375Z", + "end_time": "2018-04-05T11:16:13.5796465Z", + "active": true + }, + "dependsOn": [ + "[resourceId('Microsoft.Web/sites', parameters('sites_pnpspportalshowcase_name'))]" + ] + }, + { + "type": "Microsoft.Web/sites/hostNameBindings", + "name": "[concat(parameters('sites_pnpspportalshowcase_name'), '/', parameters('hostNameBindings_pnpspportalshowcase.azurewebsites.net_name'))]", + "apiVersion": "2016-08-01", + "location": "North Europe", + "scale": null, + "properties": { + "siteName": "pnpspportalshowcase", + "domainId": null, + "hostNameType": "Verified" + }, + "dependsOn": [ + "[resourceId('Microsoft.Web/sites', parameters('sites_pnpspportalshowcase_name'))]" + ] + } + ] +} \ No newline at end of file diff --git a/provisioning/azure.ps1 b/provisioning/azure.ps1 new file mode 100644 index 00000000..adc91d2c --- /dev/null +++ b/provisioning/azure.ps1 @@ -0,0 +1,78 @@ +Param( + [Parameter(Mandatory = $true)] + [String]$ResourceGroupPrefix, + + [Parameter(Mandatory = $false)] + [PSCredential]$Credentials, + + [Parameter(Mandatory = $false)] + [String]$SubscriptionId, + + [Parameter(Mandatory = $false)] + [String]$RepoUrl = "https://github.com/erwinvanhunen/azure-function-app", + + [Parameter(Mandatory = $false)] + [String]$Location +) + +$modules = Get-Module -Name AzureRM -ListAvailable +if ($modules -eq $null) { + # Not installed. + Install-Module -Name AzureRM -Scope CurrentUser -AllowClobber -Force + Import-Module -Name AzureRM +} + +Login-AzureRmAccount + +if($SubscriptionId) +{ + $selectedSub = Get-AzureRMSubscription -SubscriptionId $SubscriptionId +} else { + $subscriptions = Get-AzureRmSubscription -WarningAction SilentlyContinue + + $subChoices = @() + + for ($i=0; $i -lt $subscriptions.Count; $i++) { + $subChoices += [System.Management.Automation.Host.ChoiceDescription]("$($subscriptions[$i].Name) &$($i+1)") + } + + $userChoice = $host.UI.PromptForChoice('Select Subscription', 'Choose a subscription', $subChoices, 0) + 1 + + $selectedSub = $subscriptions[$userChoice] +} + +if($Location) +{ + $selectedLocation = Get-AzureRmLocation | Where-Object{$_.Location -eq $Location} +} else { + $locations = Get-AzureRMLocation -WarningAction SilentlyContinue + + $locationChoices = @() + + for($i=0; $i -lt $locations.Count; $i++) { + $locationChoices += [System.Management.Automation.Host.ChoiceDescription]("$($locations[$i].DisplayName) &$($i+1)") + } + + $locationChoice = $host.UI.PromptForChoice("Select Location","",$locationChoices,0) + 1 + + $selectedLocation = $locations[$locationChoice] + +} +Select-AzureRMSubscription -Subscription $selectedSub + +Write-Host "Creating Resource Group $ResourceGroupName" -ForegroundColor Cyan +$resourceGroup = New-AzureRmResourceGroup -Name "$($ResourceGroupPrefix)Group" -Location $selectedLocation.Location + +$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName "$($ResourceGroupPrefix)Group" -Name "$($ResourceGroupPrefix.ToLower())storage" -ErrorAction SilentlyContinue +if(!$storageAccount) +{ + Write-Host "Creating Storage Account $ResourceGroupName" -ForegroundColor Cyan + $storageAccount = New-AzureRmStorageAccount -ResourceGroupName "$($ResourceGroupPrefix)Group" -Name "$($ResourceGroupPrefix.ToLower())storage" -SkuName Standard_LRS -Location $resourceGroup.Location +} + +Write-Host "Creating Storage Queue" -ForegroundColor Cyan +$ctx = $storageAccount.Context +New-AzureStorageQueue -Name "$($ResourceGroupPrefix)queue" -Context $ctx + +Write-Host "Creating Provisioning Function App" -ForegroundColor Cyan +New-AzureRmResourceGroupDeployment -Name "PnPSPPortalCaseFunctionAppDeployment" -ResourceGroupName "$($ResourceGroupPrefix)Group" -TemplateFile .\Azure\functionapp.json -siteName "$($ResourceGroupPrefix)site" -repoUrl $RepoUrl -branch "master" -storageAccountName "$($ResourceGroupPrefix.ToLower())storage" -storageAccountid $storageAccount.Id \ No newline at end of file diff --git a/provisioning/deploy.ps1 b/provisioning/deploy.ps1 index 6be4599f..92356765 100644 --- a/provisioning/deploy.ps1 +++ b/provisioning/deploy.ps1 @@ -38,7 +38,7 @@ Param( $modules = Get-Module -Name SharePointPnPPowerShellOnline -ListAvailable if ($modules -eq $null) { # Not installed. - Install-Module -Name SharePointPnPPowerShellOnline -Scope CurrentUser + Install-Module -Name SharePointPnPPowerShellOnline -Scope CurrentUser -Force Import-Module -Name SharePointPnPPowerShellOnline -DisableNameChecking }