Merge pull request #741 from SharePoint/dev

February 2017 Release

Author: erwinvanhunen

CmdletHelpGenerator/App.config

@@ -1,6 +1,4 @@
 #if !ONPREMISES
-using System;
-using System.ComponentModel;
 using System.Linq;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
@@ -22,18 +20,22 @@ namespace SharePointPnP.PowerShell.Commands
     [CmdletExample(Code = @"PS:> Get-PnPTenantSite -Url http://tenant.sharepoint.com/sites/projects", Remarks = "Returns information about the project site.",SortOrder = 2)]
     [CmdletExample(Code = @"PS:> Get-PnPTenantSite -Detailed", Remarks = "Returns all sites with the full details of these sites", SortOrder = 3)]
     [CmdletExample(Code = @"PS:> Get-PnPTenantSite -IncludeOneDriveSites", Remarks = "Returns all sites including all OneDrive 4 Business sites", SortOrder = 4)]
-    public class GetTenantSite : SPOAdminCmdlet
+    public class GetTenantSite : PnPAdminCmdlet
     {
         [Parameter(Mandatory = false, HelpMessage = "The URL of the site", Position = 0, ValueFromPipeline = true)]
         [Alias("Identity")]
         public string Url;
 
+        [Parameter(Mandatory = false, HelpMessage = "By default, all sites will be return. Specify a template value alike 'STS#0' here to filter on the template")]
+        public string Template;
+
         [Parameter(Mandatory = false, HelpMessage = "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.")]
         public SwitchParameter Detailed;
 
         [Parameter(Mandatory = false, HelpMessage = "By default, the OneDrives are not returned. This switch includes all OneDrives. This can take some extra time to run")]
         public SwitchParameter IncludeOneDriveSites;
 
+        
         [Parameter(Mandatory = false, HelpMessage = "When the switch IncludeOneDriveSites is used, this switch ignores the question shown that the command can take a long time to execute")]
         public SwitchParameter Force;
 
@@ -54,10 +56,28 @@ protected override void ExecuteCmdlet()
                 }
                 else
                 {
+
+
                     var list = Tenant.GetSiteProperties(0, Detailed);
-                    list.Context.Load(list);
-                    list.Context.ExecuteQueryRetry();
+                  
+                    Tenant.Context.Load(list);
+                    Tenant.Context.ExecuteQueryRetry();
                     var siteProperties = list.ToList();
+                    var returnedEntries = list.Count;
+
+                    var startIndex = 0;
+                    while (returnedEntries > 299)
+                    {
+                        startIndex = startIndex + 300;
+                        var nextList = Tenant.GetSiteProperties(startIndex, Detailed);
+                        Tenant.Context.Load(nextList);
+                        Tenant.Context.ExecuteQueryRetry();
+                        siteProperties.AddRange(nextList);
+                        returnedEntries = nextList.Count;
+                    }
+
+                    
+                    
                     if (IncludeOneDriveSites)
                     {
                         if (Force || ShouldContinue(Resources.GetTenantSite_ExecuteCmdlet_This_request_can_take_a_long_time_to_execute__Continue_, Resources.Confirm))
@@ -74,7 +94,14 @@ protected override void ExecuteCmdlet()
                             }
                         }
                     }
-                    WriteObject(siteProperties.OrderBy(x => x.Url), true);
+                    if (Template != null)
+                    {
+                        WriteObject(siteProperties.Where(t => t.Template == Template).OrderBy(x => x.Url), true);
+                    }
+                    else
+                    {
+                        WriteObject(siteProperties.OrderBy(x => x.Url), true);
+                    }
                 }
             }
         }

CmdletHelpGenerator/Program.cs

@@ -1,5 +1,4 @@
 #if !ONPREMISES
-using System;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using Microsoft.SharePoint.Client;
 using SharePointPnP.PowerShell.Commands.Base;
@@ -17,7 +16,7 @@ namespace SharePointPnP.PowerShell.Commands
     [CmdletExample(Code = @"PS:> Get-PnPWebTemplates -LCID 1033", Remarks = @"Returns all webtemplates for the Locale with ID 1033 (English)", SortOrder = 2)]
     [CmdletExample(Code = @"PS:> Get-PnPWebTemplates -CompatibilityLevel 15", Remarks = @"Returns all webtemplates for the compatibility level 15", SortOrder = 2)]
     [CmdletRelatedLink(Text = "Locale IDs", Url = "http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911")]
-    public class GetWebTemplates : SPOAdminCmdlet
+    public class GetWebTemplates : PnPAdminCmdlet
     {
         [Parameter(Mandatory = false, HelpMessage = "The language ID. For instance: 1033 for English")]
         public uint Lcid;

Commands/Admin/GetTenantSite.cs

@@ -2,9 +2,9 @@
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
 using OfficeDevPnP.Core;
+using OfficeDevPnP.Core.Entities;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base;
-using OfficeDevPnP.Core.Entities;
 using Resources = SharePointPnP.PowerShell.Commands.Properties.Resources;
 
 
@@ -33,7 +33,7 @@ namespace SharePointPnP.PowerShell.Commands
     [CmdletRelatedLink(
         Text = "Creating on-premises site collections using CSOM",
         Url = "http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx")]
-    public class NewTenantSite : SPOAdminCmdlet
+    public class NewTenantSite : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = @"Specifies the title of the new site collection")]
         public string Title;

Commands/Admin/GetWebTemplates.cs

@@ -28,7 +28,7 @@ namespace SharePointPnP.PowerShell.Commands
          Remarks =
              @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin.",
          SortOrder = 3)]
-    public class RemoveSite : SPOAdminCmdlet
+    public class RemoveSite : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, HelpMessage = "Specifies the full URL of the site collection that needs to be deleted")]
         public string Url;

Commands/Admin/NewTenantSite.cs

@@ -6,7 +6,6 @@
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base;
 using System.Collections.Generic;
-using System.Threading;
 using OfficeDevPnP.Core;
 using OfficeDevPnP.Core.Entities;
 
@@ -25,7 +24,7 @@ namespace SharePointPnP.PowerShell.Commands
     [CmdletExample(
       Code = @"PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners '[email protected]'",
       Remarks = @"This will set [email protected] as a site collection owner at 'https://contoso.sharepoint.com/sites/sales'.", SortOrder = 3)]   
-    public class SetTenantSite : SPOAdminCmdlet
+    public class SetTenantSite : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = "Specifies the URL of the site", Position = 0, ValueFromPipeline = true)]
         public string Url;

Commands/Admin/RemoveTenantSite.cs

@@ -1,40 +1,39 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
 
-namespace SharePointPnP.PowerShell.Commands
+namespace SharePointPnP.PowerShell.Commands.Apps
 {
     [Cmdlet(VerbsCommon.Get, "PnPAppInstance")]
     [CmdletAlias("Get-SPOAppInstance")]
-    [CmdletHelp("Returns a SharePoint AddIn Instance in the site", 
+    [CmdletHelp("Returns a SharePoint AddIn Instance in the site",
         Category = CmdletHelpCategory.Apps,
-        OutputType= typeof(List<AppInstance>),
+        OutputType = typeof(List<AppInstance>),
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.appinstance.aspx")]
     [CmdletExample(Code = @"PS:> Get-PnPAppInstance", Remarks = @"This will return all addin instances in the site.", SortOrder = 1)]
     [CmdletExample(Code = @"PS:> Get-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe", Remarks = @"This will return an addin instance with the specified id.", SortOrder = 2)]
-    public class GetAppInstance : SPOWebCmdlet
+    public class GetAppInstance : PnPWebRetrievalsCmdlet<AppInstance>
     {
         [Parameter(Mandatory = false, Position=0, ValueFromPipeline = true, HelpMessage = "Specifies the Id of the App Instance")]
-        public GuidPipeBind Identity;
+        public AppPipeBind Identity;
 
         protected override void ExecuteCmdlet()
         {
-            
+
             if (Identity != null)
             {
-                var instance = SelectedWeb.GetAppInstanceById(Identity.Id);
-                ClientContext.Load(instance);
-                ClientContext.ExecuteQueryRetry();
+                var instance = Identity.GetAppInstance(SelectedWeb);
                 WriteObject(instance);
             }
             else
             {
                 var instances = SelectedWeb.GetAppInstances();
                 if (instances.Count > 1)
                 {
-                    WriteObject(instances,true);
+                    WriteObject(instances, true);
                 }
                 else if (instances.Count == 1)
                 {

Commands/Admin/SetTenantSite.cs

@@ -1,18 +1,18 @@
-using System.IO;
+using System.Globalization;
+using System.IO;
 using System.Management.Automation;
-using System.Globalization;
-using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using Microsoft.SharePoint.Client;
 using OfficeDevPnP.Core;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
 
-namespace SharePointPnP.PowerShell.Commands
+namespace SharePointPnP.PowerShell.Commands.Apps
 {
     [Cmdlet(VerbsData.Import, "PnPAppPackage")]
     [CmdletAlias("Import-SPOAppPackage")]
     [CmdletHelp("Adds a SharePoint Addin to a site",
-        DetailedDescription = "This commands requires that you have an addin package to deploy", 
+        DetailedDescription = "This commands requires that you have an addin package to deploy",
         Category = CmdletHelpCategory.Apps,
-         OutputType= typeof(AppInstance),
+         OutputType = typeof(AppInstance),
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.appinstance.aspx")]
     [CmdletExample(
         Code = @"PS:> Import-PnPAppPackage -Path c:\files\demo.app -LoadOnly",
@@ -22,7 +22,7 @@ namespace SharePointPnP.PowerShell.Commands
         Code = @"PS:> Import-PnPAppPackage -Path c:\files\demo.app -Force",
         Remarks = @"This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature.
     ", SortOrder = 2)]
-    public class ImportAppPackage : SPOWebCmdlet
+    public class ImportAppPackage : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, HelpMessage = "Path pointing to the .app file")]
         public string Path = string.Empty;
@@ -50,7 +50,7 @@ protected override void ExecuteCmdlet()
                     ClientContext.Site.ActivateFeature(Constants.FeatureId_Site_AppSideLoading);
                 }
                 AppInstance instance;
-           
+
 
                 var appPackageStream = new FileStream(Path, FileMode.Open, FileAccess.Read);
                 if (Locale == -1)
@@ -77,7 +77,7 @@ protected override void ExecuteCmdlet()
                 }
                 ClientContext.Load(instance);
                 ClientContext.ExecuteQueryRetry();
-                
+
 
                 if (Force)
                 {
@@ -87,7 +87,7 @@ protected override void ExecuteCmdlet()
             }
             else
             {
-                WriteError(new ErrorRecord(new IOException(Properties.Resources.FileDoesNotExist), "1", ErrorCategory.InvalidArgument, null));
+                ThrowTerminatingError(new ErrorRecord(new IOException(Properties.Resources.FileDoesNotExist), "1", ErrorCategory.InvalidArgument, null));
             }
         }
     }

Commands/Apps/GetAppInstance.cs

@@ -1,17 +1,17 @@
-using Microsoft.SharePoint.Client;
-using System.Management.Automation;
-using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
+using System.Management.Automation;
+using Microsoft.SharePoint.Client;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
 
-namespace SharePointPnP.PowerShell.Commands
+namespace SharePointPnP.PowerShell.Commands.Apps
 {
     [Cmdlet(VerbsLifecycle.Uninstall, "PnPAppInstance", SupportsShouldProcess = true)]
     [CmdletAlias("Uninstall-SPOAppInstance")]
     [CmdletHelp("Removes an app from a site", Category = CmdletHelpCategory.Apps)]
     [CmdletExample(Code = @"PS:> Uninstall-PnPAppInstance -Identity $appinstance", Remarks = "Uninstalls the app instance which was retrieved with the command Get-PnPAppInstance", SortOrder = 1)]
     [CmdletExample(Code = @"PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe", Remarks = "Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe'", SortOrder = 2)]
     [CmdletExample(Code = @"PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -force", Remarks = "Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' and do not ask for confirmation", SortOrder = 3)]
-    public class UninstallAppInstance : SPOWebCmdlet
+    public class UninstallAppInstance : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, ValueFromPipeline = true, HelpMessage = "Appinstance or Id of the addin to remove.")]
         public AppPipeBind Identity;
@@ -23,15 +23,8 @@ protected override void ExecuteCmdlet()
         {
             AppInstance instance;
 
-            if (Identity.Instance != null)
-            {
-                instance = Identity.Instance;
-            }
-            else
-            {
-                instance = SelectedWeb.GetAppInstanceById(Identity.Id);
-            }
-
+            instance = Identity.GetAppInstance(SelectedWeb);
+            
             if(instance != null)
             {
                 if(!instance.IsObjectPropertyInstantiated("Title"))