Merge pull request #553 from OfficeDev/dev

November 2016 Release

Author: erwinvanhunen

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
 ###Notice: many issues / bugs reported are actually related to the PnP Core Library which is used behind the scenes. Consider carefully where to report an issue:###
 
 1. **Are you using ```Apply-SPOProvisioningTemplate``` or ```Get-SPOProvisioningTemplate```**? The issue is most likely related to the Provisioning Engine. The Provisioning engine is _not_ located in the PowerShell repo. Please report the issue here: https://github.com/officedev/PnP-Sites-Core/issues.
-2. **Is the issue related to the cmdlet itself, its parameters, the syntax, or do you suspect it's the code of the cmdlet that is causing the issue?** Then please continue reporting the issue in this repo.
+2. **Is the issue related to the cmdlet itself, its parameters, the syntax, or do you suspect it is the code of the cmdlet that is causing the issue?** Then please continue reporting the issue in this repo.
 3. **If you think that the functionality might be related to the underlying libraries that the cmdlet is calling** (We realize that that might be difficult to determine), please first double check the code of the cmdlet, which can be found here: https://github.com/OfficeDev/PnP-PowerShell/tree/master/Commands. If related to the cmdlet, continue reporting the issue here, otherwise report the issue at https://github.com/officedev/PnP-Sites-Core/issues
 
 ### Reporting an Issue or Missing Feature

CmdletHelpGenerator/CmdletInfo.cs

@@ -25,13 +25,9 @@ public class CmdletInfo
         public string OutputTypeDescription { get; set; }
         public string OutputTypeLink { get; set; }
 
-        public string FullCommand
-        {
-            get
-            {
-                return string.Format("{0}-{1}", Verb, Noun);
-            }
-        }
+        public List<string> Aliases { get; set; }
+
+        public string FullCommand => $"{Verb}-{Noun}";
 
         public string Category { get; set; }
 
@@ -41,6 +37,7 @@ public CmdletInfo(string verb, string noun)
             Noun = noun;
             Parameters = new List<CmdletParameterInfo>();
             Syntaxes = new List<CmdletSyntax>();
+            Aliases = new List<string>();
         }
     }
 }

CmdletHelpGenerator/Program.cs

@@ -1,4 +1,5 @@
 #if !ONPREMISES
+using System;
 using System.ComponentModel;
 using System.Linq;
 using System.Management.Automation;
@@ -11,15 +12,16 @@
 namespace SharePointPnP.PowerShell.Commands
 {
 
-    [Cmdlet(VerbsCommon.Get, "SPOTenantSite", SupportsShouldProcess = true)]
+    [Cmdlet(VerbsCommon.Get, "PnPTenantSite", SupportsShouldProcess = true)]
+    [CmdletAlias("Get-SPOTenantSite")]
     [CmdletHelp(@"Office365 only: Uses the tenant API to retrieve site information.", 
         Category = CmdletHelpCategory.TenantAdmin,
         OutputType = typeof(Microsoft.Online.SharePoint.TenantAdministration.SiteProperties),
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.online.sharepoint.tenantadministration.siteproperties.aspx")]
-    [CmdletExample(Code = @"PS:> Get-SPOTenantSite", Remarks = "Returns all site collections", SortOrder = 1)]
-    [CmdletExample(Code = @"PS:> Get-SPOTenantSite -Url http://tenant.sharepoint.com/sites/projects", Remarks = "Returns information about the project site.",SortOrder = 2)]
-    [CmdletExample(Code = @"PS:> Get-SPOTenantSite -Detailed", Remarks = "Returns all sites with the full details of these sites", SortOrder = 3)]
-    [CmdletExample(Code = @"PS:> Get-SPOTenantSite -IncludeOneDriveSites", Remarks = "Returns all sites including all OneDrive 4 Business sites", SortOrder = 4)]
+    [CmdletExample(Code = @"PS:> Get-PnPTenantSite", Remarks = "Returns all site collections", SortOrder = 1)]
+    [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
     {
         [Parameter(Mandatory = false, HelpMessage = "The URL of the site", Position = 0, ValueFromPipeline = true)]
@@ -77,6 +79,5 @@ protected override void ExecuteCmdlet()
             }
         }
     }
-
 }
 #endif

Commands/Admin/GetTenantSite.cs

@@ -6,17 +6,22 @@
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.Get, "SPOTimeZoneId")]
-    [CmdletHelp("Returns a time zone ID", 
-        Category = CmdletHelpCategory.TenantAdmin,
-        OutputType = typeof(IEnumerable<Zone>),
-        OutputTypeDescription = "Returns a list of matching zones. Use the ID property of the object for use in New-SPOTenantSite")]
-    [CmdletExample(Code = @"PS:> Get-SPOTimeZoneId",Remarks = @"This will return all time zone IDs in use by Office 365.", SortOrder = 1)]
-    [CmdletExample(Code = @"PS:> Get-SPOTimeZoneId -Match Stockholm", Remarks = @"This will return the time zone IDs for Stockholm", SortOrder = 2)]
+    [Cmdlet(VerbsCommon.Get, "PnPTimeZoneId")]
+    [CmdletAlias("Get-SPOTimeZoneId")]
+    [CmdletHelp("Returns a time zone ID",
+         Category = CmdletHelpCategory.TenantAdmin,
+         OutputType = typeof(IEnumerable<Zone>),
+         OutputTypeDescription =
+             "Returns a list of matching zones. Use the ID property of the object for use in New-SPOTenantSite")]
+    [CmdletExample(Code = @"PS:> Get-PnPTimeZoneId",
+         Remarks = @"This will return all time zone IDs in use by Office 365.", SortOrder = 1)]
+    [CmdletExample(Code = @"PS:> Get-PnPTimeZoneId -Match Stockholm",
+         Remarks = @"This will return the time zone IDs for Stockholm", SortOrder = 2)]
     public class GetTimeZoneId : PSCmdlet
     {
-        [Parameter(Mandatory = false, Position=0, HelpMessage = "A string to search for like 'Stockholm'")]
-        public string Match;
+        [Parameter(Mandatory = false, Position = 0, HelpMessage = "A string to search for like 'Stockholm'")]
+        public
+            string Match;
 
         protected override void ProcessRecord()
         {
@@ -34,7 +39,11 @@ private IEnumerable<Zone> FindZone(string match)
         {
             var zones = AllZones();
 
-            var results = zones.Where(x => x.Description.ToLower().IndexOf(match.ToLower(), StringComparison.Ordinal) > -1 || x.Identifier.ToLower().Contains(match.ToLower()));
+            var results =
+                zones.Where(
+                    x =>
+                        x.Description.ToLower().IndexOf(match.ToLower(), StringComparison.Ordinal) > -1 ||
+                        x.Identifier.ToLower().Contains(match.ToLower()));
 
             return results;
         }
@@ -50,7 +59,8 @@ public IEnumerable<Zone> AllZones()
                 identifier = identifier.Replace("PLUS", "+").Replace("MINUS", "-");
                 if (identifier.Length > 3)
                 {
-                    identifier = identifier.Substring(0, identifier.Length - 2) + ":" + identifier.Substring(identifier.Length - 2, 2);
+                    identifier = identifier.Substring(0, identifier.Length - 2) + ":" +
+                                 identifier.Substring(identifier.Length - 2, 2);
                 }
 
                 description = description.Substring(description.IndexOf('_') + 1).Replace("_", " ");

Commands/Admin/GetTimeZoneId.cs

@@ -1,19 +1,21 @@
 #if !ONPREMISES
+using System;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using Microsoft.SharePoint.Client;
 using SharePointPnP.PowerShell.Commands.Base;
 using System.Management.Automation;
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.Get, "SPOWebTemplates")]
+    [Cmdlet(VerbsCommon.Get, "PnPWebTemplates")]
+    [CmdletAlias("Get-SPOWebTemplates")]
     [CmdletHelp(@"Office365 only: Returns the available web templates.", 
         Category = CmdletHelpCategory.TenantAdmin,
         OutputType=typeof(Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplateCollection),
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.online.sharepoint.tenantadministration.spotenantwebtemplatecollection.aspx")]
-    [CmdletExample(Code = @"PS:> Get-SPOWebTemplates", SortOrder = 1)]
-    [CmdletExample(Code = @"PS:> Get-SPOWebTemplates -LCID 1033", Remarks = @"Returns all webtemplates for the Locale with ID 1033 (English)", SortOrder = 2)]
-    [CmdletExample(Code = @"PS:> Get-SPOWebTemplates -CompatibilityLevel 15", Remarks = @"Returns all webtemplates for the compatibility level 15", SortOrder = 2)]
+    [CmdletExample(Code = @"PS:> Get-PnPWebTemplates", SortOrder = 1)]
+    [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
     {

Commands/Admin/GetWebTemplates.cs

@@ -6,13 +6,14 @@
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.New, "SPOTenantSite")]
+    [Cmdlet(VerbsCommon.New, "PnPTenantSite")]
+    [CmdletAlias("New-SPOTenantSite")]
     [CmdletHelp("Creates a new site collection for the current tenant", 
-        DetailedDescription = @"The New-SPOTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint
+        DetailedDescription = @"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 ", 
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-        Code = @"PS:> New-SPOTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner [email protected] -TimeZone 4",
+        Code = @"PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner [email protected] -TimeZone 4",
         Remarks = @"This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00' and the owner '[email protected]'", SortOrder = 1)]        
     [CmdletRelatedLink(
         Text ="Locale IDs", 
@@ -40,10 +41,10 @@ public class NewTenantSite : SPOAdminCmdlet
         [Parameter(Mandatory = false, HelpMessage = @"Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911.")]
         public uint Lcid = 1033;
 
-        [Parameter(Mandatory = false, HelpMessage = @"Specifies the site collection template type. Use the Get-SPOWebTemplate 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-SPOnlineWebTemplate cmdlet.")]
+        [Parameter(Mandatory = false, HelpMessage = @"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.")]
         public string Template = "STS#0";
 
-        [Parameter(Mandatory = true, HelpMessage = "Use Get-SPOTimeZoneId to retrieve possible timezone values")]
+        [Parameter(Mandatory = true, HelpMessage = "Use Get-PnPTimeZoneId to retrieve possible timezone values")]
         public int TimeZone;
 
         [Parameter(Mandatory = false, HelpMessage = @"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.")]

Commands/Admin/NewTenantSite.cs

@@ -8,17 +8,18 @@
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.Remove, "SPOTenantSite", ConfirmImpact = ConfirmImpact.High, SupportsShouldProcess = true)]
+    [Cmdlet(VerbsCommon.Remove, "PnPTenantSite", ConfirmImpact = ConfirmImpact.High, SupportsShouldProcess = true)]
+    [CmdletAlias("Remove-SPOTenantSite")]
     [CmdletHelp("Office365 only: Removes a site collection from the current tenant",
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-      Code = @"PS:> Remove-SPOTenantSite -Url https://tenant.sharepoint.com/sites/contoso",
+      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso",
       Remarks = @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso'  and put it in the recycle bin.", SortOrder = 1)]
     [CmdletExample(
-      Code = @"PS:> Remove-SPOTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin",
+      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin",
       Remarks = @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin.", SortOrder = 2)]
     [CmdletExample(
-      Code = @"PS:> Remove-SPOTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin",
+      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin",
       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
     {

Commands/Admin/RemoveTenantSite.cs

@@ -10,17 +10,18 @@
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.Set, "SPOTenantSite")]
+    [Cmdlet(VerbsCommon.Set, "PnPTenantSite")]
+    [CmdletAlias("Set-SPOTenantSite")]
     [CmdletHelp(@"Office365 only: Uses the tenant API to set site information.",
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-      Code = @"PS:> Set-SPOTenantSite -Url https://contoso.sharepoint.com -Title 'Contoso Website' -Sharing Disabled",
+      Code = @"PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title 'Contoso Website' -Sharing Disabled",
       Remarks = @"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.", SortOrder = 1)]
     [CmdletExample(
-      Code = @"PS:> Set-SPOTenantSite -Url https://contoso.sharepoint.com -Title 'Contoso Website' -StorageWarningLevel 8000 -StorageMaximumLevel 10000",
+      Code = @"PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title 'Contoso Website' -StorageWarningLevel 8000 -StorageMaximumLevel 10000",
       Remarks = @"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.", SortOrder = 2)]
     [CmdletExample(
-      Code = @"PS:> Set-SPOTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners 'i:0#.f|membership|[email protected]'",
+      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
     {

Commands/Admin/SetTenantSite.cs

@@ -6,13 +6,14 @@
 
 namespace SharePointPnP.PowerShell.Commands
 {
-    [Cmdlet(VerbsCommon.Get, "SPOAppInstance")]
+    [Cmdlet(VerbsCommon.Get, "PnPAppInstance")]
+    [CmdletAlias("Get-SPOAppInstance")]
     [CmdletHelp("Returns a SharePoint AddIn Instance in the site", 
         Category = CmdletHelpCategory.Apps,
         OutputType= typeof(List<AppInstance>),
         OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.appinstance.aspx")]
-    [CmdletExample(Code = @"PS:> Get-SPOAppInstance", Remarks = @"This will return all addin instances in the site.", SortOrder = 1)]
-    [CmdletExample(Code = @"PS:> Get-SPOAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe", Remarks = @"This will return an addin instance with the specified id.", SortOrder = 2)]
+    [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
     {
         [Parameter(Mandatory = false, Position=0, ValueFromPipeline = true, HelpMessage = "Specifies the Id of the App Instance")]