Adding in depth verbose logging to Graph based cmdlets (#4023)

* Adding additional information, removing alias as it works inversed from the original cmdlet name, only kept the Graph name and ditched the Exchange Online name

* Added code to distinguish the type of token being used (Delegate vs AppOnly) and using it to show a warning if properties are being set with the wrong token type

* Renaming method as this makes more sense

* Changed code to pass along the cmdlet instance so logging can take place in deeper levels

* Rewrote async functionality to become sync as PowerShell doesn't support async handling anyway

* Optimized logging

* Further fixes and optimization

* Removing logging oauth token to verbose output

* Add verbose logging of HTTP body

* Removed async from method as it was no longer async anyway

* Fixing Sync HttpClient Sends to support HTTP/2

* Further testing and optimization. Now also writing verbose if the permissions set through the attribute above the cmdlet are present in the current access token.

* Added code to distinguish the type of token being used (Delegate vs AppOnly) and using it to show a warning if properties are being set with the wrong token type

* Renaming method as this makes more sense

* Removing logging oauth token to verbose output

* Add verbose logging of HTTP body

* Removed async from method as it was no longer async anyway

* Nightly publish to PowerShell Gallery

* Nightly publish to PowerShell Gallery

* Updated documentation for Set-PnPFolderPermission (#4025)

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>

* Update Set-PnPList.md (#4020)

See #3783 where an issue is described when this feature is not activated. So maybe this PR makes the documentation more clear.

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>

* New cmdlet for Get-PnPTenantRestrictedSearchAllowedList (#3997)

* new cmdlet

* correct space

* add documentation

---------

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>

* Update CHANGELOG.md

* Feature #4028 : return EnableAIPIntegation in Get-PnPTenant cmdlet (#4030)

Co-authored-by: Gautam Sheth <gautam.sheth@staffbase.com>

* Fix #3908: improve connection validation in ConnectOnline.cs (#4031)

Co-authored-by: Gautam Sheth <gautam.sheth@staffbase.com>

* Adding `-IsSharePointAddInsDisabled` to `Set-PnPTenant` (#4032)

* Added -IsSharePointAddInsDisabled to Set-PnPTenant

* Added PR reference

* Nightly publish to PowerShell Gallery

* Nightly publish to PowerShell Gallery

* Fix error handling in Remove-PnPTeamsChannel (#4036)

Fix Remove-PnPTeamsChannel error handling mismatch between "Team not found", "Channel not found" and no error.

* Update CHANGELOG.md

* More settings related to version trim ,ReadOnlyForUnmanagedDevices and RestrictContentOrgWideSearch (#4024)

* More settings related to version trim ,ReadOnlyForUnmanagedDevices and RestrictContentOrgWideSearch

* remove reference to forms

* remove version trim settings

---------

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>

* Update CHANGELOG.md

* Fixing Sync HttpClient Sends to support HTTP/2

* Further testing and optimization. Now also writing verbose if the permissions set through the attribute above the cmdlet are present in the current access token.

* Rebasing to close the gap with dev

* Added changelog entry

* Optimizations

* Code cleanup and simplification

* Fixing typo

* Moving changelog entry to nightly

---------

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>
Co-authored-by: erwinvanhunen <erwinvanhunen@users.noreply.github.com>
Co-authored-by: Paolo Pialorsi <paolo@pialorsi.com>
Co-authored-by: Mark Gort <52573368+markgort86@users.noreply.github.com>
Co-authored-by: Reshmee Auckloo <reshmee011@gmail.com>
Co-authored-by: Gautam Sheth <gautam.sheth@staffbase.com>
Co-authored-by: Giacomo Pozzoni <giacomopoz@gmail.com>

Author: 8 people

CHANGELOG.md

@@ -9,7 +9,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 ## [Current Nightly]
 
 ### Added
-
+- Added in depth verbose logging to all cmdlets which is revealed by adding `-Verbose` to the cmdlet execution [#4023](https://github.com/pnp/powershell/pull/4023)
+  
 ### Fixed
 
 ### Changed
@@ -18,6 +19,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Contributors
 
+- Koen Zomers [koenzomers]
+  
 ## [2.5.0]
 
 ### Added

src/Commands/Admin/GetTenantInfo.cs

@@ -35,7 +35,7 @@ protected override void ExecuteCmdlet()
             var requestUrl = BuildRequestUrl();
 
             WriteVerbose($"Making call to {requestUrl} to request tenant information");
-            var results = RestHelper.GetAsync<Model.TenantInfo>(Connection.HttpClient, requestUrl, graphAccessToken).GetAwaiter().GetResult();
+            var results = RestHelper.Get<Model.TenantInfo>(Connection.HttpClient, requestUrl, graphAccessToken);
             WriteObject(results, true);
         }
 

src/Commands/Admin/PublishCompanyApp.cs

@@ -185,7 +185,7 @@ protected override void ExecuteCmdlet()
             if (!NoUpload)
             {
                 var bytes = System.IO.File.ReadAllBytes(System.IO.Path.Combine(SessionState.Path.CurrentFileSystemLocation.Path, $"{AppName}.zip"));
-                TeamsUtility.AddAppAsync(Connection, GraphAccessToken, bytes).GetAwaiter().GetResult();
+                TeamsUtility.AddApp(this, Connection, GraphAccessToken, bytes);
                 WriteObject($"Teams app uploaded to teams app Store.");
             }
         }

src/Commands/Admin/RenameTenantSite.cs

@@ -68,7 +68,7 @@ protected override void ExecuteCmdlet()
                 OperationId = Guid.Empty
             };
 
-            var results = Utilities.REST.RestHelper.PostAsync<SPOSiteRenameJob>(HttpClient, $"{AdminContext.Url.TrimEnd('/')}/_api/SiteRenameJobs?api-version=1.4.7", AdminContext, body, false).GetAwaiter().GetResult();
+            var results = Utilities.REST.RestHelper.Post<SPOSiteRenameJob>(HttpClient, $"{AdminContext.Url.TrimEnd('/')}/_api/SiteRenameJobs?api-version=1.4.7", AdminContext, body, false);
             if (!Wait.IsPresent)
             {
                 if (results != null)

src/Commands/Apps/AddAzureADServicePrincipalAppRole.cs

@@ -34,7 +34,7 @@ public class AddAzureADServicePrincipalAppRole : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var principal = Principal.GetServicePrincipal(Connection, AccessToken);
+            var principal = Principal.GetServicePrincipal(this, Connection, AccessToken);
 
             if(principal == null)
             {
@@ -47,7 +47,7 @@ protected override void ExecuteCmdlet()
 
             if (AppRole.AppRole == null)
             {
-                var resource = ParameterSetName == ParameterSet_BYBUILTINTYPE ? ServicePrincipalUtility.GetServicePrincipalByBuiltInType(Connection, AccessToken, BuiltInType) : Resource.GetServicePrincipal(Connection, AccessToken);
+                var resource = ParameterSetName == ParameterSet_BYBUILTINTYPE ? ServicePrincipalUtility.GetServicePrincipalByBuiltInType(this, Connection, AccessToken, BuiltInType) : Resource.GetServicePrincipal(this, Connection, AccessToken);
 
                 if (resource == null)
                 {
@@ -67,7 +67,7 @@ protected override void ExecuteCmdlet()
 
             WriteVerbose($"Adding app role {appRole.Value}: {appRole.DisplayName}");
 
-            var response = ServicePrincipalUtility.AddServicePrincipalRoleAssignment(Connection, AccessToken, principal, appRole);
+            var response = ServicePrincipalUtility.AddServicePrincipalRoleAssignment(this, Connection, AccessToken, principal, appRole);
             WriteObject(response, false);
         }
     }

src/Commands/Apps/GetAzureADAppSitePermission.cs

@@ -52,14 +52,14 @@ protected override void ExecuteCmdlet()
                     var accessToken = AccessToken;
 
                     // All permissions, first fetch just the Ids as the API works in a weird way that requesting all permissions does not reveal their roles, so we will request all permissions and then request each permission individually so we will also have the roles
-                    var permissions = GraphHelper.GetResultCollectionAsync<AzureADAppPermissionInternal>(Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions?$select=Id", accessToken).GetAwaiter().GetResult();
+                    var permissions = GraphHelper.GetResultCollection<AzureADAppPermissionInternal>(this, Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions?$select=Id", accessToken);
                     if (permissions.Any())
                     {
                         var results = new List<AzureADAppPermission>();
                         foreach (var permission in permissions)
                         {
                             // Request the permission individually so it will include the roles
-                            var detailedApp = GraphHelper.GetAsync<AzureADAppPermissionInternal>(Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions/{permission.Id}", accessToken).GetAwaiter().GetResult();
+                            var detailedApp = GraphHelper.Get<AzureADAppPermissionInternal>(this, Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions/{permission.Id}", accessToken);
                             results.Add(detailedApp.Convert());
                         }
 
@@ -76,7 +76,7 @@ protected override void ExecuteCmdlet()
                 }
                 else
                 {
-                    var results = GraphHelper.GetAsync<AzureADAppPermissionInternal>(Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions/{PermissionId}", AccessToken).GetAwaiter().GetResult();
+                    var results = GraphHelper.Get<AzureADAppPermissionInternal>(this, Connection, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions/{PermissionId}", AccessToken);
                     WriteObject(results.Convert());
                 }
             }

src/Commands/Apps/GetAzureADServicePrincipal.cs

@@ -42,19 +42,19 @@ protected override void ExecuteCmdlet()
             switch (ParameterSetName)
             {
                 case ParameterSet_BYAPPID:
-                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByAppId(Connection, AccessToken, AppId);
+                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByAppId(this, Connection, AccessToken, AppId);
                     break;
                 case ParameterSet_BYOBJECTID:
-                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByObjectId(Connection, AccessToken, ObjectId);
+                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByObjectId(this, Connection, AccessToken, ObjectId);
                     break;
                 case ParameterSet_BYAPPNAME:
-                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByAppName(Connection, AccessToken, AppName);
+                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByAppName(this, Connection, AccessToken, AppName);
                     break;
                 case ParameterSet_BYBUILTINTYPE:
-                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByBuiltInType(Connection, AccessToken, BuiltInType);
+                    servicePrincipal = ServicePrincipalUtility.GetServicePrincipalByBuiltInType(this, Connection, AccessToken, BuiltInType);
                     break;
                 case ParameterSet_ALL:
-                    var servicePrincipals = ServicePrincipalUtility.GetServicePrincipals(Connection, AccessToken, Filter);
+                    var servicePrincipals = ServicePrincipalUtility.GetServicePrincipals(this, Connection, AccessToken, Filter);
                     WriteObject(servicePrincipals, true);
                     return;
             }

src/Commands/Apps/GetAzureADServicePrincipalAssignedAppRole.cs

@@ -22,7 +22,7 @@ public class GetAzureADServicePrincipalAssignedAppRole : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var principal = Principal.GetServicePrincipal(Connection, AccessToken);
+            var principal = Principal.GetServicePrincipal(this, Connection, AccessToken);
 
             if(principal == null)
             {
@@ -31,7 +31,7 @@ protected override void ExecuteCmdlet()
 
             WriteVerbose($"Requesting currently assigned app roles to service principal {principal.DisplayName}");
 
-            var appRoleAssignments = ServicePrincipalUtility.GetServicePrincipalAppRoleAssignmentsByServicePrincipalObjectId(Connection, AccessToken, principal.Id);
+            var appRoleAssignments = ServicePrincipalUtility.GetServicePrincipalAppRoleAssignmentsByServicePrincipalObjectId(this, Connection, AccessToken, principal.Id);
             if(ParameterSpecified(nameof(Identity)))
             {
                 var appRole = Identity.GetAvailableAppRole(Connection, AccessToken, principal);

src/Commands/Apps/GetAzureADServicePrincipalAvailableAppRole.cs

@@ -21,7 +21,7 @@ public class GetAzureADServicePrincipalAvailableAppRole : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var principal = Principal.GetServicePrincipal(Connection, AccessToken);
+            var principal = Principal.GetServicePrincipal(this, Connection, AccessToken);
 
             if(principal == null)
             {

src/Commands/Apps/GrantAzureADAppSitePermission.cs

@@ -56,7 +56,7 @@ protected override void ExecuteCmdlet()
 
             // Adding a fix for multi-geo issue
             // https://github.com/pnp/powershell/issues/2801
-            var multiGeoFix = Utilities.REST.RestHelper.GetAsync(Connection.HttpClient, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}", AccessToken).GetAwaiter().GetResult();
+            var multiGeoFix = Utilities.REST.RestHelper.Get(Connection.HttpClient, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}", AccessToken);
 
             // Construct the payload of the Graph request
             var payload = new
@@ -83,7 +83,7 @@ protected override void ExecuteCmdlet()
             WriteVerbose($"Granting App with Id {AppId} the permission{(payload.roles.Length != 1 ? "s" : "")} {string.Join(',', payload.roles)}");
 
             // Make the Graph Grant request
-            var result = Utilities.REST.RestHelper.PostAsync<AzureADAppPermissionInternal>(Connection.HttpClient, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions", AccessToken, payload).GetAwaiter().GetResult();
+            var result = Utilities.REST.RestHelper.Post<AzureADAppPermissionInternal>(Connection.HttpClient, $"https://{Connection.GraphEndPoint}/v1.0/sites/{siteId}/permissions", AccessToken, payload);
             WriteObject(result.Convert());
         }
     }