Add -User parameter to Get-PnPTeamsTeam cmdlet and enhance team model with summary details (#4894)

Co-authored-by: Gautam Sheth <[email protected]>

Author: gautamdsheth

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Added
 - Added `-NewFileName` parameter to `Convert-PnPFile` cmdlet to choose custom output file name.
+- Added `-User` parameter to `Get-PnPTeamsTeam` cmdlet to allow fetching list of teams a user has access to.
 
 ### Fixed
 - Fix `Set-PnPView -Aggregations` parameter not showing aggregations in SharePoint online. [#4868](https://github.com/pnp/powershell/pull/4868)

documentation/Get-PnPTeamsTeam.md

@@ -20,7 +20,7 @@ Gets one Microsoft Teams Team or a list of Teams.
 ## SYNTAX
 
 ```powershell
-Get-PnPTeamsTeam [-Identity <TeamsTeamPipeBind>] [-Filter <String>]  
+Get-PnPTeamsTeam [-Identity <TeamsTeamPipeBind>] [-Filter <String>]  [-User <AzureADUserPipeBind>]
 ```
 
 ## DESCRIPTION
@@ -64,6 +64,13 @@ Get-PnPTeamsTeam -Filter "startswith(description, 'contoso')"
 
 Retrieves all Microsoft Teams instances with Description starting with "contoso". This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/en-us/graph/aad-advanced-queries?tabs=http#group-properties).
 
+### EXAMPLE 6
+```powershell
+Get-PnPTeamsTeam -User "[email protected]"
+```
+
+Retrieves all Microsoft Teams instances which the specified user has access to.
+
 ## PARAMETERS
 
 ### -Identity
@@ -94,8 +101,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -User
+Specify the name of the user to fetch the list of teams user as access to.
 
-## RELATED LINKS
+```yaml
+Type: AzureADUserPipeBind
+Parameter Sets: User
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
 
-[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
+## RELATED LINKS
 
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

src/Commands/Model/Teams/Team.cs

@@ -101,6 +101,21 @@ public class Team
         /// </summary>
         public DateTimeOffset? CreatedDateTime { get; set; }
 
+        /// <summary>
+        /// The summary for the Team
+        /// </summary>
+        public TeamSummary Summary { get; set; }
+
+        /// <summary>
+        /// Tenant ID of the team
+        /// </summary>
+        public string TenantId { get; set; }
+
+        /// <summary>
+        /// Whether the Team membership is limited to owners
+        /// </summary>
+        public bool? IsMembershipLimitedToOwners { get; set; }
+
         #endregion
     }
 
@@ -130,4 +145,31 @@ public enum TeamSpecialization
         /// </summary>
         EducationStaff
     }
+
+
+    public class JoinedTeam
+    {
+        #region Public Members
+
+        public Guid Id { get; set; }
+
+        public string DisplayName { get; set; }
+
+        /// <summary>
+        /// Declares whether the Team is archived or not
+        /// </summary>
+        public bool? IsArchived { get; set; }
+
+        /// <summary>
+        /// Declares the description for the team
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Tenant ID of the team
+        /// </summary>
+        public Guid TenantId { get; set; }
+
+        #endregion
+    }
 }

src/Commands/Model/Teams/TeamSummary.cs

@@ -0,0 +1,15 @@
+namespace PnP.PowerShell.Commands.Model.Teams
+{
+    public partial class TeamSummary
+    {
+        #region Public Members
+
+        public int GuestsCount { get; set; }
+
+        public int MembersCount { get; set; }
+
+        public int OwnersCount { get; set; }
+
+        #endregion
+    }
+}

src/Commands/Teams/GetTeamsTeam.cs

@@ -13,6 +13,7 @@ public class GetTeamsTeam : PnPGraphCmdlet
     {
         private const string ParameterSet_Identity = "Identity";
         private const string ParameterSet_Filter = "Filter";
+        private const string ParameterSet_User = "User";
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_Identity)]
         public TeamsTeamPipeBind Identity;
@@ -25,6 +26,9 @@ public class GetTeamsTeam : PnPGraphCmdlet
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_Filter)]
         public string Filter = null;
 
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_User)]
+        public AzureADUserPipeBind User;
+
         protected override void ExecuteCmdlet()
         {
             if (ParameterSpecified(nameof(Identity)))
@@ -41,7 +45,20 @@ protected override void ExecuteCmdlet()
             }
             else
             {
-                WriteObject(TeamsUtility.GetTeamUsingFilter(GraphRequestHelper, Filter));
+                if (ParameterSpecified(nameof(User)))
+                {
+                    var user = User.GetUser(AccessToken, Connection.AzureEnvironment);
+                    if (user == null)
+                    {
+                        LogWarning("Provided user not found");
+                        return;
+                    }
+                    WriteObject(TeamsUtility.GetJoinedTeams(GraphRequestHelper, user.Id.Value));
+                }
+                else
+                {
+                    WriteObject(TeamsUtility.GetTeamUsingFilter(GraphRequestHelper, Filter));
+                }
             }
         }
     }

src/Commands/ToDo/GetTodoList.cs

@@ -36,7 +36,7 @@ protected override void ExecuteCmdlet()
                     LogWarning("Provided user not found");
                     return;
                 }
-                url = $"/v1.0/users/{user.Id}/todo/lists";
+                url = $"/v1.0/users/{user.Id.Value}/todo/lists";
             }
             if (ParameterSpecified(nameof(Identity)))
             {

src/Commands/ToDo/NewTodoList.cs

@@ -36,7 +36,7 @@ protected override void ExecuteCmdlet()
                     LogWarning("Provided user not found");
                     return;
                 }
-                url = $"/v1.0/users/{user.Id}/todo/lists";
+                url = $"/v1.0/users/{user.Id.Value}/todo/lists";
             }
 
             var stringContent = new StringContent($"{{'displayName':'{DisplayName}'}}");

src/Commands/ToDo/RemoveTodoList.cs

@@ -28,7 +28,7 @@ protected override void ExecuteCmdlet()
                     LogWarning("Provided user not found");
                     return;
                 }
-                url = $"/v1.0/users/{user.Id}/todo/lists/{Identity}";
+                url = $"/v1.0/users/{user.Id.Value}/todo/lists/{Identity}";
             }
 
             var graphResult = GraphRequestHelper.Delete(url);

src/Commands/ToDo/UpdateTodoList.cs

@@ -32,7 +32,7 @@ protected override void ExecuteCmdlet()
                     LogWarning("Provided user not found");
                     return;
                 }
-                url = $"/v1.0/users/{user.Id}/todo/lists/{Identity}";
+                url = $"/v1.0/users/{user.Id.Value}/todo/lists/{Identity}";
             }
 
             var stringContent = new StringContent($"{{'displayName':'{DisplayName}'}}");

src/Commands/Utilities/REST/ApiRequestHelper.cs

@@ -7,7 +7,6 @@
 using System.Management.Automation;
 using System.Net;
 using System.Net.Http;
-using System.Text;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading;
@@ -215,7 +214,7 @@ public IEnumerable<T> GetResultCollection<T>(string url, bool camlCasePolicy = t
             var results = new List<T>();
             var request = Get<RestResultCollection<T>>(url, camlCasePolicy, propertyNameCaseInsensitive, additionalHeaders);
 
-            if (request.Items.Any())
+            if (request != null && request.Items.Any())
             {
                 results.AddRange(request.Items);
                 while (!string.IsNullOrEmpty(request.NextLink))
@@ -264,7 +263,7 @@ public T Get<T>(string url, bool camlCasePolicy = true, bool propertyNameCaseIns
                 }
                 catch (Exception e)
                 {
-                    LogError($"Failed to parse response from server. Error message: '{e.Message}'. Received content: '{stringContent}'. Model type to parse it to: '{typeof(T)}'.");
+                    LogError($"Failed to parse response from server. Error message: '{e.Message}'. Model type to parse it to: '{typeof(T)}'.");
                     //Cmdlet.LogWarning($"Failed to parse response from server. Error message: '{e.Message}'. Received content: '{stringContent}'. Model type to parse it to: '{typeof(T)}'.");
                     return default;
                 }
@@ -311,7 +310,7 @@ public T Delete<T>(Cmdlet cmdlet, PnPConnection connection, string url, bool cam
 
         #region PATCH
         public T Patch<T>(string url, T content, IDictionary<string, string> additionalHeaders = null, bool camlCasePolicy = true)
-        { 
+        {
             var serializerSettings = new JsonSerializerOptions() { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull };
             if (camlCasePolicy)
             {
@@ -387,7 +386,7 @@ private void PostInternal(string url, HttpContent content, IDictionary<string, s
         {
             var message = GetMessage(url, HttpMethod.Post, content, additionalHeaders);
             GetResponseMessage(message);
-        }        
+        }
 
         private T PostInternal<T>(string url, HttpContent content, IDictionary<string, string> additionalHeaders = null, bool propertyNameCaseInsensitive = false)
         {
@@ -455,7 +454,7 @@ public HttpResponseMessage Put2(string url, HttpContent content, string accessTo
         {
             var message = GetMessage2(url, accessToken, HttpMethod.Put, content, additionalHeaders);
             return GetResponseMessage2(message);
-        }        
+        }
 
         #endregion
 

src/Commands/Utilities/TeamsUtility.cs

@@ -455,6 +455,14 @@ public static IEnumerable<DeletedTeam> GetDeletedTeam(ApiRequestHelper requestHe
             }
             return null;
         }
+
+        public static List<JoinedTeam> GetJoinedTeams(ApiRequestHelper requestHelper, Guid userId)
+        {
+            string requestUrl = $"v1.0/users/{userId}/joinedTeams";
+            var collection = requestHelper.GetResultCollection<JoinedTeam>(requestUrl);
+            return collection.ToList();
+
+        }
         #endregion
 
         #region Users