Merge pull request #2971 from KoenZomers/InvokePnPGraphMethodToFile

Adding option to write Graph output from `Invoke-PnPGraphMethod` to file

Author: gautamdsheth

CHANGELOG.md

@@ -10,9 +10,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+- Added `-OutFile` to `Invoke-PnPGraphMethod` which allows for the response to be written to a file [#2971](https://github.com/pnp/powershell/pull/2971)
+
 ### Contributors
 
 - [dhiabedoui]
+- Koen Zomers [koenzomers]
 
 ## [2.1.1]
 

documentation/Invoke-PnPGraphMethod.md

@@ -14,6 +14,7 @@ Invokes a REST request towards the Microsoft Graph API
 
 ## SYNTAX
 
+### Out to console (Default)
 ```powershell
 Invoke-PnPGraphMethod -Url <String>
                       [-AdditionalHeaders <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
@@ -24,7 +25,20 @@ Invoke-PnPGraphMethod -Url <String>
                       [-Raw]
                       [-All] 
                       [-Connection <PnPConnection>]
-                      [<CommonParameters>]
+                      [-Verbose]
+```
+
+### Out to file
+```powershell
+Invoke-PnPGraphMethod -Url <String>
+                      [-AdditionalHeaders <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
+                      [[-Method] <HttpRequestMethod>] 
+                      [-Content <Object>] 
+                      [-ContentType <String>] 
+                      [-ConsistencyLevelEventual] 
+                      [-Connection <PnPConnection>]
+                      [-OutFile <String>]
+                      [-Verbose]
 ```
 
 ## DESCRIPTION
@@ -68,6 +82,13 @@ Invoke-PnPGraphMethod "https://graph.microsoft.com/v1.0/users"
 
 Performs a GET request to retrieve users from the Microsoft Graph API using the full URL.
 
+### Example 6
+```powershell
+Invoke-PnPGraphMethod "https://graph.microsoft.com/v1.0/users/user@contoso.com/photo/`$value" -OutFile c:\temp\photo.jpg
+```
+
+Downloads the user profile photo of the specified user to the specified file.
+
 ## PARAMETERS
 
 ### -AdditionalHeaders
@@ -90,7 +111,7 @@ Retrieve all pages of results. This will loop through all @odata.nextLink. This
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: Out to console
 Aliases:
 
 Required: False
@@ -178,12 +199,27 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -OutFile
+The full path including filename to write the output to, i.e. c:\temp\myfile.txt. Existing files will be overwritten.
+
+```yaml
+Type: String
+Parameter Sets: Out to file
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Raw
 If specified the returned data will not be converted to an object but returned as a JSON string.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: Out to console
 Aliases:
 
 Required: False
@@ -210,4 +246,4 @@ Accept wildcard characters: False
 
 ## RELATED LINKS
 
-[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

src/Commands/Graph/InvokeGraphMethod.cs

@@ -11,15 +11,20 @@
 
 namespace PnP.PowerShell.Commands.Base
 {
-    [Cmdlet(VerbsLifecycle.Invoke, "PnPGraphMethod")]
+    [Cmdlet(VerbsLifecycle.Invoke, "PnPGraphMethod", DefaultParameterSetName = ParameterSet_TOCONSOLE)]
     public class InvokeGraphMethod : PnPGraphCmdlet
     {
-        [Parameter(Mandatory = false)]
+        private const string ParameterSet_TOFILE = "Out to file";
+        private const string ParameterSet_TOCONSOLE = "Out to console";
+
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public HttpRequestMethod Method = HttpRequestMethod.Get;
 
         private string _url;
 
-        [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
+        [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_TOCONSOLE)]
         public string Url
         {
             get { return _url; }
@@ -41,15 +46,18 @@ public string Url
             }
         }
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public object Content;
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public string ContentType = "application/json";
 
         IDictionary<string, string> additionalHeaders = null;
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public IDictionary<string, string> AdditionalHeaders
         {
             get
@@ -71,15 +79,19 @@ public IDictionary<string, string> AdditionalHeaders
             }
         }
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public SwitchParameter ConsistencyLevelEventual;
 
-        [Parameter(Mandatory = false)]
-        public SwitchParameter Raw;
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
+        public SwitchParameter Raw;      
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
         public SwitchParameter All;
 
+        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_TOFILE)]
+        public string OutFile;
+
         protected override void ExecuteCmdlet()
         {
             try
@@ -121,7 +133,14 @@ private void SendRequest()
                 switch (Method)
                 {
                     case HttpRequestMethod.Get:
-                        GetRequest();
+                        if(string.IsNullOrWhiteSpace(OutFile)) 
+                        {
+                            GetRequestWithPaging();
+                        }
+                        else
+                        {
+                            GetRequestWithoutPaging();
+                        }
                         return;
                     case HttpRequestMethod.Post:
                         PostRequest();
@@ -178,7 +197,7 @@ private void WriteGraphResult(string result)
             }
         }
 
-        private void GetRequest()
+        private void GetRequestWithPaging()
         {
             var result = GraphHelper.GetAsync(Connection, Url, AccessToken, AdditionalHeaders).GetAwaiter().GetResult();
             if (Raw.IsPresent)
@@ -226,33 +245,63 @@ private void GetRequest()
                 WriteObject(rootObj);
             }
         }
+        
+        private void GetRequestWithoutPaging()
+        {
+            WriteVerbose($"Sending HTTP GET to {Url}");
+            using var response = GraphHelper.GetResponseAsync(Connection, Url, AccessToken).GetAwaiter().GetResult();
+            HandleResponse(response);
+        }
 
         private void PostRequest()
         {
+            WriteVerbose($"Sending HTTP POST to {Url}");
             var response = GraphHelper.PostAsync(Connection, Url, AccessToken, GetHttpContent(), AdditionalHeaders).GetAwaiter().GetResult();
-            var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
-            WriteGraphResult(result);
+            HandleResponse(response);
         }
 
         private void PutRequest()
         {
+            WriteVerbose($"Sending HTTP PUT to {Url}");
             var response = GraphHelper.PutAsync(Connection, Url, AccessToken, GetHttpContent(), AdditionalHeaders).GetAwaiter().GetResult();
-            var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
-            WriteGraphResult(result);
+            HandleResponse(response);
         }
 
         private void PatchRequest()
         {
+            WriteVerbose($"Sending HTTP PATCH to {Url}");
             var response = GraphHelper.PatchAsync(Connection, AccessToken, GetHttpContent(), Url, AdditionalHeaders).GetAwaiter().GetResult();
-            var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
-            WriteGraphResult(result);
+            HandleResponse(response);
         }
 
         private void DeleteRequest()
         {
+            WriteVerbose($"Sending HTTP DELETE to {Url}");
             var response = GraphHelper.DeleteAsync(Connection, Url, AccessToken, AdditionalHeaders).GetAwaiter().GetResult();
-            var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
-            WriteGraphResult(result);
+            HandleResponse(response);
         }
+
+        private void HandleResponse(HttpResponseMessage response)
+        {
+            if(ParameterSpecified(nameof(OutFile)))
+            {
+                var responseStream = response.Content.ReadAsStreamAsync().GetAwaiter().GetResult();
+
+                WriteVerbose($"Writing {responseStream.Length} bytes response to {OutFile}");
+
+                using var fileStream = new System.IO.FileStream(OutFile, System.IO.FileMode.Create, System.IO.FileAccess.Write);
+                responseStream.CopyTo(fileStream);
+                fileStream.Close();
+                return;
+            }
+            else
+            {                
+                var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
+
+                WriteVerbose($"Returning {result.Length} characters response");
+                
+                WriteGraphResult(result);
+            }
+        }        
     }
 }