Merge pull request #2005 from erwinvanhunen/dev

April 2019 Release

Author: erwinvanhunen

Commands/Admin/GetHomeSite.cs

@@ -0,0 +1,26 @@
+#if !ONPREMISES
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base;
+using System.Management.Automation;
+
+namespace SharePointPnP.PowerShell.Commands.Admin
+{
+    [Cmdlet(VerbsCommon.Get, "PnPHomeSite")]
+    [CmdletHelp("Returns the home site url for your tenant",
+     SupportedPlatform = CmdletSupportedPlatform.Online,
+     Category = CmdletHelpCategory.TenantAdmin)]
+    [CmdletExample(
+     Code = @"PS:> Get-PnPHomeSite",
+     Remarks = @"Returns the home site url for your tenant", SortOrder = 1)]
+    public class GetHomeSite : PnPAdminCmdlet
+    {
+        protected override void ExecuteCmdlet()
+        {
+            var results = Tenant.GetSPHSiteUrl();
+            ClientContext.ExecuteQueryRetry();
+            WriteObject(results.Value);
+        }
+    }
+}
+#endif

Commands/Admin/NewTenantSite.cs

@@ -1,10 +1,12 @@
-using System;
-using System.Management.Automation;
-using Microsoft.SharePoint.Client;
+using Microsoft.SharePoint.Client;
 using OfficeDevPnP.Core;
+#if ONPREMISES
 using OfficeDevPnP.Core.Entities;
+#endif
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base;
+using System;
+using System.Management.Automation;
 using Resources = SharePointPnP.PowerShell.Commands.Properties.Resources;
 
 
@@ -17,11 +19,11 @@ namespace SharePointPnP.PowerShell.Commands
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
         Code = @"PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner [email protected] -TimeZone 4 -Template STS#0",
-        Remarks = @"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 '[email protected]' and the template used will be STS#0, a TeamSite", 
+        Remarks = @"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 '[email protected]' and the template used will be STS#0, a TeamSite",
         SortOrder = 1)]
     [CmdletExample(
         Code = @"PS:> New-PnPTenantSite -Title Contoso -Url /sites/contososite -Owner [email protected] -TimeZone 4 -Template STS#0",
-        Remarks = @"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 '[email protected]' and the template used will be STS#0, a TeamSite", 
+        Remarks = @"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 '[email protected]' and the template used will be STS#0, a TeamSite",
         SortOrder = 2)]
     [CmdletRelatedLink(
         Text = "Locale IDs",
@@ -40,7 +42,8 @@ public class NewTenantSite : PnPAdminCmdlet
         [Parameter(Mandatory = true, HelpMessage = @"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.")]
         public string Url;
 
-        [Parameter(Mandatory = false, HelpMessage = @"Specifies the description of the new site collection")]
+        [Obsolete("This parameter is currently ignored due to server side API issues when setting this value.")]
+        [Parameter(Mandatory = false, HelpMessage = @"Specifies the description of the new site collection. Setting a value for this parameter will override the Wait parameter as we have to set the description after the site has been created.")]
         public string Description = string.Empty;
 
         [Parameter(Mandatory = true, HelpMessage = @"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.")]
@@ -103,11 +106,15 @@ protected override void ExecuteCmdlet()
                 entity.UserCodeMaximumLevel = ResourceQuota;
                 entity.UserCodeWarningLevel = ResourceQuotaWarningLevel;
                 entity.Lcid = Lcid;
-
                 Tenant.CreateSiteCollection(entity);
 #else
                 Func<TenantOperationMessage, bool> timeoutFunction = TimeoutFunction;
 
+                if (MyInvocation.BoundParameters.ContainsKey("Description"))
+                {
+                    // We have to fall back to synchronous behaviour as we have to wait for the site to be present in order to set the description.
+                    Wait = true;
+                }
 
                 Tenant.CreateSiteCollection(Url, Title, Owner, Template, (int)StorageQuota,
                     (int)StorageQuotaWarningLevel, TimeZone, (int)ResourceQuota, (int)ResourceQuotaWarningLevel, Lcid,

Commands/Admin/RemoveHomeSite.cs

@@ -0,0 +1,40 @@
+#if !ONPREMISES
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base;
+using System.Management.Automation;
+
+namespace SharePointPnP.PowerShell.Commands.Admin
+{
+    [Cmdlet(VerbsCommon.Remove, "PnPHomeSite")]
+    [CmdletHelp("Removes the currently set site as the home site",
+     SupportedPlatform = CmdletSupportedPlatform.Online,
+     Category = CmdletHelpCategory.TenantAdmin)]
+    [CmdletExample(
+     Code = @"PS:> Remove-PnPHomeSite",
+     Remarks = @"Removes the currently set site as the home site", SortOrder = 1)]
+    public class RemoveHomeSite : PnPAdminCmdlet
+    {
+        [Parameter(Mandatory = false, HelpMessage = "Specifying the Force parameter will skip the confirmation question.")]
+        public SwitchParameter Force;
+
+        protected override void ExecuteCmdlet()
+        {
+            var homesiteUrl = Tenant.GetSPHSiteUrl();
+            ClientContext.ExecuteQueryRetry();
+            if (!string.IsNullOrEmpty(homesiteUrl.Value))
+            {
+                if (Force || ShouldContinue($"Remove {homesiteUrl.Value} as the home site?", Properties.Resources.Confirm))
+                {
+                    Tenant.RemoveSPHSite();
+                    ClientContext.ExecuteQueryRetry();
+                }
+            }
+            else
+            {
+                WriteWarning("There is currently not site collection set as a home site in your tenant.");
+            }
+        }
+    }
+}
+#endif

Commands/Admin/SetHomeSite.cs

@@ -0,0 +1,28 @@
+#if !ONPREMISES
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base;
+using System.Management.Automation;
+
+namespace SharePointPnP.PowerShell.Commands.Admin
+{
+    [Cmdlet(VerbsCommon.Set, "PnPHomeSite")]
+    [CmdletHelp("Sets the home site for your tenant",
+     SupportedPlatform = CmdletSupportedPlatform.Online,
+     Category = CmdletHelpCategory.TenantAdmin)]
+    [CmdletExample(
+     Code = @"PS:> Set-PnPHomeSite -Url https://yourtenant.sharepoint.com/sites/myhome",
+     Remarks = @"Sets the home site to the provided site collection url", SortOrder = 1)]
+    public class SetHomeSite : PnPAdminCmdlet
+    {
+        [Parameter(Mandatory = true, HelpMessage = "The url of the site to set as the home site")]
+        public string Url;
+
+        protected override void ExecuteCmdlet()
+        {
+            Tenant.SetSPHSite(Url);
+            ClientContext.ExecuteQueryRetry();
+        }
+    }
+}
+#endif

Commands/SharePointPnP.PowerShell.Commands.csproj

@@ -538,6 +538,9 @@
     <Compile Include="Admin\AddOffice365GroupToSite.cs" />
     <Compile Include="Admin\AddSiteCollectionAppCatalog.cs" />
     <Compile Include="Admin\AddTenantTheme.cs" />
+    <Compile Include="Admin\GetHomeSite.cs" />
+    <Compile Include="Admin\RemoveHomeSite.cs" />
+    <Compile Include="Admin\SetHomeSite.cs" />
     <Compile Include="Apps\DenyTenantServicePrincipalPermissionRequest.cs" />
     <Compile Include="Apps\DisableTenantServicePrincipal.cs" />
     <Compile Include="Apps\GrantTenantServicePrincipalPermission.cs" />