Merge pull request #1172 from SharePoint/dev

October 2017 Intermediate Release 2

Author: erwinvanhunen

Commands/Apps/UpdateApp.cs

@@ -0,0 +1,25 @@
+#if !ONPREMISES
+using OfficeDevPnP.Core.ALM;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
+using System.Management.Automation;
+
+namespace SharePointPnP.PowerShell.Commands.Apps
+{
+    [Cmdlet(VerbsData.Update, "PnPApp")]
+    [CmdletHelp("Updates an available app from the app catalog",
+        Category = CmdletHelpCategory.Apps, SupportedPlatform = CmdletSupportedPlatform.Online)]
+    [CmdletExample(Code = @"PS:> Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe", Remarks = @"This will update an already installed app if a new version is available.", SortOrder = 1)]
+    public class UpdateApp : PnPCmdlet
+    {
+        [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, HelpMessage = "Specifies the Id or an actual app metadata instance")]
+        public AppMetadataPipeBind Identity;
+
+        protected override void ExecuteCmdlet()
+        {
+            var manager = new AppManager(ClientContext);
+            manager.Upgrade(Identity.GetId());
+        }
+    }
+}
+#endif

Commands/Base/PipeBinds/ClientSidePagePipeBind.cs

@@ -53,7 +53,7 @@ internal ClientSidePage GetPage(ClientContext ctx)
                 {
                     return ClientSidePage.Load(ctx, Name);
                 }
-                catch (ArgumentException ex)
+                catch (ArgumentException)
                 {
                     return null;
                 }

Commands/Base/PipeBinds/GroupPipeBind.cs

@@ -34,6 +34,8 @@ public GroupPipeBind(string name)
 
         internal Group GetGroup(Web web)
         {
+            var clientContext = web.Context;
+
             Group group = null;
             if (Id != -1)
             {
@@ -46,11 +48,12 @@ internal Group GetGroup(Web web)
             else if (Group != null)
             {
                 group = Group;
+                clientContext = group.Context;
             }
 
-            web.Context.Load(group);
-            web.Context.Load(group.Users);
-            web.Context.ExecuteQueryRetry();
+            clientContext.Load(group);
+            clientContext.Load(group.Users);
+            clientContext.ExecuteQueryRetry();
             return group;
         }
     }

Commands/Branding/AddCustomAction.cs

@@ -80,6 +80,9 @@ public class AddCustomAction : PnPWebCmdlet
         public UserCustomActionRegistrationType RegistrationType;
 
         [Parameter(Mandatory = false, HelpMessage = "The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.", ParameterSetName = ParameterSet_DEFAULT)]
+#if !ONPREMISES
+        [Parameter(Mandatory = false, HelpMessage = "The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.", ParameterSetName = ParameterSet_CLIENTSIDECOMPONENTID)]
+#endif
         public CustomActionScope Scope = CustomActionScope.Web;
 #if !ONPREMISES
         [Parameter(Mandatory = true, HelpMessage = "The Client Side Component Id of the custom action", ParameterSetName = ParameterSet_CLIENTSIDECOMPONENTID)]

Commands/Lists/GetListItem.cs

@@ -20,27 +20,27 @@ namespace SharePointPnP.PowerShell.Commands.Lists
         SortOrder = 1)]
     [CmdletExample(
         Code = "PS:> Get-PnPListItem -List Tasks -Id 1",
-        Remarks = "Retrieves the list item with ID 1 from from the Tasks list. This parameter is ignored if the Query parameter is specified.",
+        Remarks = "Retrieves the list item with ID 1 from from the Tasks list",
         SortOrder = 2)]
     [CmdletExample(
         Code = "PS:> Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3",
-        Remarks = "Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists. This parameter is ignored if the Query parameter is specified.",
+        Remarks = "Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists",
         SortOrder = 3)]
     [CmdletExample(
-        Code = "PS:> Get-PnPListItem -List Tasks -Fields \"Title\",\"GUID\"",
-        Remarks = "Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object. This parameter is ignored if the Query parameter is specified.",
+        Code = "PS:> (Get-PnPListItem -List Tasks -Fields \"Title\",\"GUID\").FieldValues",
+        Remarks = "Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object",
         SortOrder = 4)]
     [CmdletExample(
         Code = "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>\"",
-        Remarks = "Retrieves all list items based on the CAML query specified.",
+        Remarks = "Retrieves all list items based on the CAML query specified",
         SortOrder = 5)]
     [CmdletExample(
         Code = "PS:> Get-PnPListItem -List Tasks -PageSize 1000",
-        Remarks = "Retrieves all list items from the Tasks list in pages of 1000 items. This parameter is ignored if the Query parameter is specified.",
+        Remarks = "Retrieves all list items from the Tasks list in pages of 1000 items",
         SortOrder = 6)]
     [CmdletExample(
         Code = "PS:> Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | % { $_.BreakRoleInheritance($true, $true) }",
-        Remarks = "Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item.",
+        Remarks = "Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item",
         SortOrder = 7)]
     public class GetListItem : PnPWebCmdlet
     {

Commands/Principals/GetGroupMembers.cs

@@ -0,0 +1,37 @@
+using System.Management.Automation;
+using Microsoft.SharePoint.Client;
+using SharePointPnP.PowerShell.CmdletHelpAttributes;
+using SharePointPnP.PowerShell.Commands.Base.PipeBinds;
+
+namespace SharePointPnP.PowerShell.Commands.Principals
+{
+    [Cmdlet(VerbsCommon.Get, "PnPGroupMembers")]
+    [CmdletHelp("Retrieves all members of a group",
+        Category = CmdletHelpCategory.Principals,
+        DetailedDescription = "This command will return all the users that are a member of the provided SharePoint Group",
+        OutputType = typeof(User),
+        OutputTypeLink = "https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.user.aspx")]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPGroupMembers -Identity 'Marketing Site Members'",
+        SortOrder = 1,
+        Remarks = @"Returns all the users that are a member of the group 'Marketing Site Members' in the current sitecollection")]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPGroup | Get-PnPGroupMembers",
+        SortOrder = 2,
+        Remarks = @"Returns all the users that are a member of any of the groups in the current sitecollection")]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMembers",
+        SortOrder = 3,
+        Remarks = @"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")]
+    public class GetGroupMembers : PnPWebCmdlet
+    {
+        [Parameter(Mandatory = true, ValueFromPipeline = true, HelpMessage = "A group object, an ID or a name of a group")]
+        public GroupPipeBind Identity;
+
+        protected override void ExecuteCmdlet()
+        {
+            var group = Identity.GetGroup(SelectedWeb);
+            WriteObject(group.Users, true);
+        }
+    }
+}

Commands/Principals/GetUser.cs

@@ -61,31 +61,31 @@ protected override void ExecuteCmdlet()
             };
 
             if (Identity == null) {
-                ClientContext.Load(SelectedWeb.SiteUsers, users => users.Include(retrievalExpressions));
-                ClientContext.ExecuteQueryRetry();
+                SelectedWeb.Context.Load(SelectedWeb.SiteUsers, users => users.Include(retrievalExpressions));
+                SelectedWeb.Context.ExecuteQueryRetry();
                 WriteObject(SelectedWeb.SiteUsers, true);
             }
             else
             {
                 User user = null;
                 if (Identity.Id > 0)
                 {
-                    user = ClientContext.Web.GetUserById(Identity.Id);
+                    user = SelectedWeb.GetUserById(Identity.Id);
                 }
                 else if (Identity.User != null && Identity.User.Id > 0)
                 {
-                    user = ClientContext.Web.GetUserById(Identity.User.Id);
+                    user = SelectedWeb.GetUserById(Identity.User.Id);
                 }
                 else if (!string.IsNullOrWhiteSpace(Identity.Login))
                 {
-                    user = ClientContext.Web.SiteUsers.GetByLoginName(Identity.Login);
+                    user = SelectedWeb.SiteUsers.GetByLoginName(Identity.Login);
                 }
                 if (user != null) {
-                    ClientContext.Load(user, retrievalExpressions);
-                    ClientContext.ExecuteQueryRetry();
+                    SelectedWeb.Context.Load(user, retrievalExpressions);
+                    SelectedWeb.Context.ExecuteQueryRetry();
                 }
                 WriteObject(user);
             }
         }
     }
-}
+}

Commands/Properties/AssemblyInfo.cs

@@ -44,6 +44,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.19.1710.1")]
-[assembly: AssemblyFileVersion("2.19.1710.1")]
+[assembly: AssemblyVersion("2.19.1710.2")]
+[assembly: AssemblyFileVersion("2.19.1710.2")]
 [assembly: InternalsVisibleTo("SharePointPnP.PowerShell.Tests")]

Commands/RecordsManagement/SetInPlaceRecordsManagement.cs

@@ -17,6 +17,10 @@ namespace SharePointPnP.PowerShell.Commands.RecordsManagement
         Code = @"PS:> Set-PnPInPlaceRecordsManagement -On",
         Remarks = "Activates In Place Records Management",
         SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> Set-PnPInPlaceRecordsManagement -Off",
+        Remarks = "Deactivates In Place Records Management",
+        SortOrder = 2)]
     public class SetInPlaceRecordsManagement : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, Position = 0, HelpMessage = "Turn records management on", ParameterSetName = "On")]

Commands/Search/SetSearchConfiguration.cs

@@ -24,7 +24,7 @@ namespace SharePointPnP.PowerShell.Commands.Search
         Remarks = "Sets the search configuration for the current tenant",
         SortOrder = 3)]
     [CmdletExample(
-          Code = @"PS:> Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription",
+        Code = @"PS:> Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription",
         Remarks = "Reads the search configuration from the specified XML file and sets it for the current tenant",
         SortOrder = 4)]