Merge pull request #2976 from KoenZomers/InvokeGraphReturnStream

Added `-OutStream` to `Invoke-PnPGraphMethod`

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 `-OutFile` to `Invoke-PnPGraphMethod` which allows for the response to be written to a file [#2971](https://github.com/pnp/powershell/pull/2971)
+- Added `-OutStream` to `Invoke-PnPGraphMethod` which allows for the response to be written to a memory stream [#2976](https://github.com/pnp/powershell/pull/2976)
 
 ### Contributors
 

documentation/Invoke-PnPGraphMethod.md

@@ -41,6 +41,19 @@ Invoke-PnPGraphMethod -Url <String>
                       [-Verbose]
 ```
 
+### Out to stream
+```powershell
+Invoke-PnPGraphMethod -Url <String>
+                      [-AdditionalHeaders <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
+                      [[-Method] <HttpRequestMethod>] 
+                      [-Content <Object>] 
+                      [-ContentType <String>] 
+                      [-ConsistencyLevelEventual] 
+                      [-Connection <PnPConnection>]
+                      [-OutStream]
+                      [-Verbose]
+```
+
 ## DESCRIPTION
 Invokes a REST request towards the Microsoft Graph API. It will take care of potential throttling retries that are needed to retrieve the data.
 
@@ -89,6 +102,13 @@ Invoke-PnPGraphMethod "https://graph.microsoft.com/v1.0/users/user@contoso.com/p
 
 Downloads the user profile photo of the specified user to the specified file.
 
+### Example 7
+```powershell
+Invoke-PnPGraphMethod "https://graph.microsoft.com/v1.0/users/user@contoso.com/photo/`$value" -OutStream | Add-PnPFile -FileName user.jpg -Folder "Shared Documents"
+```
+
+Takes the user profile photo of the specified user and uploads it to the specified library in SharePoint Online.
+
 ## PARAMETERS
 
 ### -AdditionalHeaders
@@ -214,6 +234,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -OutStream
+Indicates that the result of the request should be returned as a memory stream.
+
+```yaml
+Type: String
+Parameter Sets: Out to stream
+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.
 

src/Commands/Files/AddFile.cs

@@ -32,7 +32,7 @@ public class AddFile : PnPWebCmdlet
         [ValidateNotNullOrEmpty]
         public string NewFileName = string.Empty;
 
-        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_ASSTREAM)]
+        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_ASSTREAM, ValueFromPipeline = true, Position = 0)]
         [ValidateNotNullOrEmpty]
         public Stream Stream;
 

src/Commands/Graph/InvokeGraphMethod.cs

@@ -8,12 +8,14 @@
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Text.Json.Serialization;
+using System.IO;
 
 namespace PnP.PowerShell.Commands.Base
 {
     [Cmdlet(VerbsLifecycle.Invoke, "PnPGraphMethod", DefaultParameterSetName = ParameterSet_TOCONSOLE)]
     public class InvokeGraphMethod : PnPGraphCmdlet
     {
+        private const string ParameterSet_TOSTREAM = "Out to stream";
         private const string ParameterSet_TOFILE = "Out to file";
         private const string ParameterSet_TOCONSOLE = "Out to console";
 
@@ -25,6 +27,7 @@ public class InvokeGraphMethod : PnPGraphCmdlet
 
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_TOFILE)]
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_TOCONSOLE)]
+        [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_TOSTREAM)]
         public string Url
         {
             get { return _url; }
@@ -48,16 +51,19 @@ public string Url
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOSTREAM)]
         public object Content;
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOSTREAM)]
         public string ContentType = "application/json";
 
         IDictionary<string, string> additionalHeaders = null;
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOSTREAM)]
         public IDictionary<string, string> AdditionalHeaders
         {
             get
@@ -81,6 +87,7 @@ public IDictionary<string, string> AdditionalHeaders
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOFILE)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
+        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOSTREAM)]
         public SwitchParameter ConsistencyLevelEventual;
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet_TOCONSOLE)]
@@ -92,6 +99,9 @@ public IDictionary<string, string> AdditionalHeaders
         [Parameter(Mandatory = true, ParameterSetName = ParameterSet_TOFILE)]
         public string OutFile;
 
+        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_TOSTREAM)]
+        public SwitchParameter OutStream;        
+
         protected override void ExecuteCmdlet()
         {
             try
@@ -133,7 +143,7 @@ private void SendRequest()
                 switch (Method)
                 {
                     case HttpRequestMethod.Get:
-                        if(string.IsNullOrWhiteSpace(OutFile)) 
+                        if(ParameterSetName == ParameterSet_TOCONSOLE) 
                         {
                             GetRequestWithPaging();
                         }
@@ -283,24 +293,46 @@ private void DeleteRequest()
 
         private void HandleResponse(HttpResponseMessage response)
         {
-            if(ParameterSpecified(nameof(OutFile)))
+            switch (ParameterSetName)
             {
-                var responseStream = response.Content.ReadAsStreamAsync().GetAwaiter().GetResult();
+                case ParameterSet_TOCONSOLE:
+                    var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
 
-                WriteVerbose($"Writing {responseStream.Length} bytes response to {OutFile}");
+                    WriteVerbose($"Returning {result.Length} characters response");
 
-                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();
+                    WriteGraphResult(result);
+                    break;
+
+                case ParameterSet_TOFILE:
+                    using (var responseStreamForFile = response.Content.ReadAsStream())
+                    {
+                        WriteVerbose($"Writing {responseStreamForFile.Length} bytes response to {OutFile}");
+
+                        using (var fileStream = new System.IO.FileStream(OutFile, System.IO.FileMode.Create, System.IO.FileAccess.Write))
+                        {
+                            responseStreamForFile.CopyTo(fileStream);
+                            fileStream.Close();
+                        }
+                    }
+                    break;
+
+                case ParameterSet_TOSTREAM:
+                    var responseStream = response.Content.ReadAsStream();
+                    
+                    WriteVerbose($"Writing {responseStream.Length} bytes response to outputstream");
+
+                    var memoryStream = new System.IO.MemoryStream();
+                    responseStream.CopyTo(memoryStream);
+                    memoryStream.Position = 0;
+
+                    responseStream.Close();
+                    responseStream.Dispose();
+
+                    WriteObject(memoryStream);
+                    break;
 
-                WriteVerbose($"Returning {result.Length} characters response");
-                
-                WriteGraphResult(result);
+                default:
+                    throw new Exception($"Parameter set {ParameterSetName} not supported");
             }
         }        
     }