Merge pull request #1505 from SharePoint/dev

April 2018 Release

Author: erwinvanhunen

CHANGELOG.md

@@ -5,6 +5,55 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [2.25.1804.0] - Unreleased
+### Added
+- Added -Tree parameter to Get-PnPNavigationNode which will return a tree representation of the selected navigation structure
+- Added -Parent parameter which takes an ID to Add-PnPNavigationNode instead of using the -Header parameter
+- Added -Scope parameter to Add-PnPApp, Get-PnPApp, Install-PnPApp, Publish-PnPApp, Remove-PnPApp, Uninstall-PnPApp, Unpublish-PnPApp, Update-PnPApp to support site collection app catalog
+- Added -Wait parameter to Install-PnPApp which will wait for the installation to finish
+- Added Get-PnPHideDefaultThemes cmdlet
+- Added Set-PnPHideDefaultThemes cmdlet
+- Added Get-PnPListRecordDeclaration cmdlet
+- Added Set-PnPListRecordDeclaration cmdlet
+- Added Get-PnPInPlaceRecordsManagement cmdlet
+- Added Get-PnPInformationRightsManagement cmdlet
+- Added Set-PnPInformationRightsManagement cmdlet
+- Added New-PnPUPABulkImportJob cmdlet
+- Added Get-PnPUPABulkImportStatus cmdlet
+
+### Changed
+
+- Added additional properties to Set-PnPList: Description, EnableFolderCreation, ForceCheckout, ListExperience
+- ALM Cmdlets (Add-PnPApp, etc.) now allow for specifying the app title instead of only an id.
+- Updated Set-PnPInPlaceRecordsManagement cmdlet to use a -Enabled parameter instead of -On and -Off
+- Add-PnPClientSideWebPart and Add-PnPClientSideText now return the client side component added
+- Fixed issue with Set-PnPTenantTheme not recognizing a parameter value accordingly
+- Added -HideDefaultThemes parameter to Set-PnPTenant
+- Get-PnPTenant now returns if default themes are hidden or not
+- Added ability to cancel Device Login requests with CTRL+C
+- Renamed Connect-PnPHubSite to Add-PnPHubSiteAssociation and added alias for Connect-PnPHubSite
+- Renamed Disconnect-PnPHubSite to Remove-PnPHubSiteAssociation and added alias for Disconnect-PnPHubSite
+- Fixed output of File/Folder objects which caused the creation of an error message that was not thrown to the output but was available in the $error built-in variable
+- Fixed Set-PnPUserProfileProperty cmdlet to accept $null values to clear properties
+- Fixed Invoke-PnPSiteDesign where you connected to the -admin URL, and it ignored the WebUrl parameter when applying the site design
+- Added WebUrl parameter to Set-PnPWebTheme to support connection via -admin URL needed by app-only connections
+- Fixed issue with 
+
+### Deprecated
+- Deprecated -Header parameter on Add-PnPNavigationNode in favor or -Parent [Id]
+- Deprecated Disable-PnPInPlaceRecordsManagementForSite in favor of Set-PnPInPlaceRecordsManagement -Enabled $true
+- Deprecated Enabled-PnPInPlaceRecordsManagementForSite in favor of Set-PnPInPlaceRecordsManagement -Disabled $true
+- Deprecated Connect-PnPHubSite. Use Add-PnPHubSiteAssociation
+- Deprecated Disconnect-PnPHubSite. Use Remove-PnPHubSiteAssociation
+
+### Contributors
+casselc
+stevebeauge
+velingeorgiev
+cebud
+jensotto
+
+
 ## [2.24.1803.0] - 2018-03-06
 ### Added
 - Added Get-PnPTenant cmdlet

Commands/Admin/ConnectHubSite.cs renamed to Commands/Admin/AddHubSiteAssociation.cs

@@ -10,15 +10,16 @@
 
 namespace SharePointPnP.PowerShell.Commands.Admin
 {
-    [Cmdlet(VerbsCommunications.Connect, "PnPHubSite")]
+    [Cmdlet(VerbsCommon.Add, "PnPHubSiteAssociation")]
+    [Alias("Connect-PnPHubSite")]
     [CmdletHelp("Connects a site to a hubsite.",
         DetailedDescription = @"Connects an existing site to a hubsite",
         SupportedPlatform = CmdletSupportedPlatform.Online,
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-        Code = @"PS:> Connect-PnPHubSite -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite",
+        Code = @"PS:> Add-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite",
         Remarks = @"This example adds the specified site to the hubsite.", SortOrder = 1)]
-    public class ConnectHubSite : PnPAdminCmdlet
+    public class AddHubSiteAssociation : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = @"The site to connect to the hubsite")]
         public SitePipeBind Site;

Commands/Admin/GetHideDefaultThemes.cs

@@ -0,0 +1,35 @@
+#if !ONPREMISES
+using Microsoft.Online.SharePoint.TenantAdministration;
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base;
+using System.Management.Automation;
+using OfficeDevPnP.Core.Sites;
+using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
+using System;
+using SharePointPnP.PowerShell.Commands.Enums;
+using System.Collections.Generic;
+using SharePointPnP.PowerShell.Commands.Model;
+
+namespace SharePointPnP.PowerShell.Commands.Admin
+{
+    [Cmdlet(VerbsCommon.Get, "PnPHideDefaultThemes")]
+    [CmdletHelp(@"Returns if the default / OOTB themes should be visible to users or not.",
+        DetailedDescription = @"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.",
+        SupportedPlatform = CmdletSupportedPlatform.Online,
+        Category = CmdletHelpCategory.TenantAdmin)]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPHideDefaultThemes",
+        Remarks = @"This example returns the current setting if the default themes should be visible", SortOrder = 1)]
+    public class GetHideDefaultThemes : PnPAdminCmdlet
+    {
+        protected override void ExecuteCmdlet()
+        {
+            var value = Tenant.EnsureProperty(t => t.HideDefaultThemes);
+            WriteObject(value);
+        }
+    }
+}
+#endif

Commands/Admin/GetTenant.cs

@@ -31,6 +31,7 @@ public class GetTenant : PnPAdminCmdlet
         protected override void ExecuteCmdlet()
         {
             ClientContext.Load(Tenant);
+            ClientContext.Load(Tenant, t => t.HideDefaultThemes);
             ClientContext.ExecuteQueryRetry();
             WriteObject(new SPOTenant(Tenant));
         }

Commands/Admin/DisconnectHubSite.cs renamed to Commands/Admin/RemoveHubSiteAssociation.cs

@@ -10,15 +10,16 @@
 
 namespace SharePointPnP.PowerShell.Commands.Admin
 {
-    [Cmdlet(VerbsCommunications.Disconnect, "PnPHubSite")]
+    [Cmdlet(VerbsCommon.Remove, "PnPHubSiteAssociation")]
+    [Alias("Disconnect-PnPHubSite")]
     [CmdletHelp("Disconnects a site from a hubsite.",
         DetailedDescription = @"Disconnects an site from a hubsite",
         SupportedPlatform = CmdletSupportedPlatform.Online,
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-        Code = @"PS:> Disconnect-PnPHubSite -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite",
+        Code = @"PS:> Remove-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite",
         Remarks = @"This example adds the specified site to the hubsite.", SortOrder = 1)]
-    public class DisconnectHubSite : PnPAdminCmdlet
+    public class RemoveHubSiteAssociation : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = @"The site to disconnect from its hubsite")]
         public SitePipeBind Site;

Commands/Admin/SetHideDefaultThemes.cs

@@ -0,0 +1,41 @@
+#if !ONPREMISES
+using Microsoft.Online.SharePoint.TenantAdministration;
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base;
+using System.Management.Automation;
+using OfficeDevPnP.Core.Sites;
+using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
+using System;
+using SharePointPnP.PowerShell.Commands.Enums;
+using System.Collections.Generic;
+using SharePointPnP.PowerShell.Commands.Model;
+
+namespace SharePointPnP.PowerShell.Commands.Admin
+{
+    [Cmdlet(VerbsCommon.Set, "PnPHideDefaultThemes")]
+    [CmdletHelp(@"Defines if the default / OOTB themes should be visible to users or not.",
+        DetailedDescription = @"Use this cmdlet to hide or show the default themes to users
+
+You must be a SharePoint Online global administrator to run the cmdlet.",
+        SupportedPlatform = CmdletSupportedPlatform.Online,
+        Category = CmdletHelpCategory.TenantAdmin)]
+    [CmdletExample(
+        Code = @"PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $true",
+        Remarks = @"This example hides the default themes", SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $false",
+        Remarks = @"This example shows the default themes", SortOrder = 1)]
+    public class SetHideDefaultThemes : PnPAdminCmdlet
+    {
+        [Parameter(Mandatory = true, HelpMessage = "Defines if the default themes should be visible or hidden")]
+        public bool HideDefaultThemes = false;
+
+        protected override void ExecuteCmdlet()
+        {
+            Tenant.HideDefaultThemes = HideDefaultThemes;
+            ClientContext.ExecuteQueryRetry();
+        }
+    }
+}
+#endif

Commands/Admin/SetTenant.cs

@@ -10,12 +10,10 @@
 namespace SharePointPnP.PowerShell.Commands.Admin
 {
     [Cmdlet(VerbsCommon.Set, "PnPTenant", DefaultParameterSetName = ParameterAttribute.AllParameterSets)]
-    [CmdletHelp(@"Returns organization-level site collection properties",
-        DetailedDescription = @"Returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota,
+    [CmdletHelp(@"Sets organization-level site collection properties",
+        DetailedDescription = @"Sets 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.",
         SupportedPlatform = CmdletSupportedPlatform.Online,
         Category = CmdletHelpCategory.TenantAdmin)]
@@ -401,6 +399,9 @@ The only two characters that can be managed at this time are the # and % charact
         [Parameter(Mandatory = false)]
         public int? EmailAttestationReAuthDays;
 
+        [Parameter(Mandatory = false, HelpMessage = "Defines if the default themes are visible or hidden")]
+        public bool? HideDefaultThemes;
+
         protected override void ExecuteCmdlet()
         {
             ClientContext.Load(Tenant);
@@ -632,7 +633,7 @@ protected override void ExecuteCmdlet()
                 Tenant.DisallowInfectedFileDownload = DisallowInfectedFileDownload.Value;
                 isDirty = true;
             }
-            if (string.IsNullOrEmpty(SharingBlockedDomainList))
+            if (!string.IsNullOrEmpty(SharingBlockedDomainList))
             {
                 if (!Tenant.RequireAcceptingAccountMatchInvitedAccount)
                 {
@@ -952,6 +953,11 @@ protected override void ExecuteCmdlet()
                 }
                 isDirty = true;
             }
+            if(HideDefaultThemes.HasValue)
+            {
+                Tenant.HideDefaultThemes = HideDefaultThemes.Value;
+                isDirty = true;
+            }
             if (isDirty)
             {
                 ClientContext.ExecuteQueryRetry();

Commands/Admin/SetTenantCdnPolicy.cs

@@ -18,18 +18,18 @@ namespace SharePointPnP.PowerShell.Commands.Admin
         SupportedPlatform = CmdletSupportedPlatform.Online,
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-        Code = @"PS:> Set-PnPTenantCdnPolicies -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue ""CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF""",
+        Code = @"PS:> Set-PnPTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue ""CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF""",
         Remarks = @"This example sets the IncludeFileExtensions policy to the specified value.", SortOrder = 1)]
     public class SetTenantCdnPolicy : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = "The type of cdn to retrieve the policies from")]
         public SPOTenantCdnType CdnType;
 
         [Parameter(Mandatory = true, HelpMessage = "The type of the policy to set")]
-        public SPOTenantCdnPolicyType PolicyType { get; set; }
+        public SPOTenantCdnPolicyType PolicyType;
 
         [Parameter(Mandatory = true, HelpMessage = "The value of the policy to set")]
-        public string PolicyValue { get; set; }
+        public string PolicyValue;
 
         protected override void ExecuteCmdlet()
         {

Commands/Apps/AddApp.cs

@@ -1,6 +1,8 @@
 #if !ONPREMISES
 using OfficeDevPnP.Core.ALM;
+using OfficeDevPnP.Core.Enums;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Enums;
 using System.Management.Automation;
 
 namespace SharePointPnP.PowerShell.Commands.Apps
@@ -15,6 +17,9 @@ namespace SharePointPnP.PowerShell.Commands.Apps
     [CmdletExample(
         Code = @"PS:> Add-PnPApp -Path ./myapp.sppkg -Publish",
         Remarks = @"This will upload the specified app package to the app catalog and deploy/trust it at the same time.", SortOrder = 2)]
+    [CmdletExample(
+        Code = @"PS:> Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish",
+        Remarks = @"This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time.", SortOrder = 2)]
     public class AddApp : PnPCmdlet
     {
         private const string ParameterSet_ADD = "Add only";
@@ -24,6 +29,9 @@ public class AddApp : PnPCmdlet
         [Parameter(Mandatory = true, Position = 0, ParameterSetName = ParameterSet_PUBLISH, ValueFromPipeline = true, HelpMessage = "Specifies the Id or an actual app metadata instance")]
         public string Path;
 
+        [Parameter(Mandatory = false, HelpMessage = "Defines which app catalog to use. Defaults to Tenant")]
+        public AppCatalogScope Scope = AppCatalogScope.Tenant;
+
         [Parameter(Mandatory = true, ValueFromPipeline = false, ParameterSetName = ParameterSet_PUBLISH, HelpMessage = "This will deploy/trust an app into the app catalog")]
         public SwitchParameter Publish;
 
@@ -46,7 +54,7 @@ protected override void ExecuteCmdlet()
 
             var manager = new AppManager(ClientContext);
 
-            var result = manager.Add(bytes, fileInfo.Name, Overwrite);
+            var result = manager.Add(bytes, fileInfo.Name, Overwrite, Scope);
 
             try
             {
@@ -55,7 +63,7 @@ protected override void ExecuteCmdlet()
                 {
                     if (manager.Deploy(result, SkipFeatureDeployment))
                     {
-                        result = manager.GetAvailable(result.Id);
+                        result = manager.GetAvailable(result.Id, Scope);
                     }
 
                 }

Commands/Apps/GetApp.cs

@@ -6,46 +6,53 @@
 using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
 using OfficeDevPnP.Core.ALM;
 using System;
+using SharePointPnP.PowerShell.Commands.Enums;
+using OfficeDevPnP.Core.Enums;
 
 namespace SharePointPnP.PowerShell.Commands.Apps
 {
     [Cmdlet(VerbsCommon.Get, "PnPApp")]
     [CmdletHelp("Returns the available apps from the app catalog",
         Category = CmdletHelpCategory.Apps,
         OutputType = typeof(List<AppMetadata>), SupportedPlatform = CmdletSupportedPlatform.Online)]
-    [CmdletExample(Code = @"PS:> Get-PnPApp", Remarks = @"This will return all available app metadata from the tenant app catalog. It will list the installed version in the current site.", SortOrder = 1)]
-    [CmdletExample(Code = @"PS:> Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f", Remarks = @"This will the specific app metadata from the app catalog.", SortOrder = 2)]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPApp", 
+        Remarks = @"This will return all available apps from the tenant app catalog. It will list the installed version in the current site.", 
+        SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPApp -Scope Site", 
+        Remarks = @"This will return all available apps from the site collection scoped app catalog. It will list the installed version in the current site.", 
+        SortOrder = 2)]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f", 
+        Remarks = @"This willr retrieve the specific app from the app catalog.", 
+        SortOrder = 3)]
     public class GetApp : PnPCmdlet
     {
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true, HelpMessage = "Specifies the Id of an app which is available in the app catalog")]
         public AppMetadataPipeBind Identity;
 
+        [Parameter(Mandatory = false, HelpMessage = "Defines which app catalog to use. Defaults to Tenant")]
+        public AppCatalogScope Scope = AppCatalogScope.Tenant;
+
         protected override void ExecuteCmdlet()
         {
             var manager = new AppManager(ClientContext);
 
             if (MyInvocation.BoundParameters.ContainsKey("Identity"))
             {
-                AppMetadata app = null;
-                if (Identity.Id != Guid.Empty)
-                {
-                    app = manager.GetAvailable(Identity.Id);
-                } else if(!string.IsNullOrEmpty(Identity.Title))
-                {
-                    app = manager.GetAvailable(Identity.Title);
-                }
+                var app = Identity.GetAppMetadata(ClientContext, Scope);
                 if (app != null)
                 {
                     WriteObject(app);
-                }
-                else
+                } else
                 {
-                    throw new System.Exception("App not found");
+                    throw new Exception("Cannot find app");
                 }
             }
             else
             {
-                var apps = manager.GetAvailable();
+                var apps = manager.GetAvailable(Scope);
                 WriteObject(apps,true);
             }
         }