How to create C# async powershell method?

Question

So I want to create a way to run a powershell script asynchronously. The below code is what I have so far, but it doesn't seem to be async because it locks up the application and the output is incorrect.

    public static string RunScript(string scriptText)
    {
        PowerShell ps = PowerShell.Create().AddScript(scriptText);

        // Create an IAsyncResult object and call the
        // BeginInvoke method to start running the 
        // pipeline asynchronously.
        IAsyncResult async = ps.BeginInvoke();

        // Using the PowerShell.EndInvoke method, get the
        // results from the IAsyncResult object.
        StringBuilder stringBuilder = new StringBuilder();
        foreach (PSObject result in ps.EndInvoke(async))
        {
            stringBuilder.AppendLine(result.Methods.ToString());
        } // End foreach.

        return stringBuilder.ToString();
    }

SLaks · Accepted Answer · 2013-07-14 15:09:53Z

9

You are calling it asynchronously.

However, you are then defeating the purpose by synchronously waiting for the asynchronous operation to finish, by calling EndInvoke().

To actually run it asynchronously, you need to make your method asynchronous too.
You can do that by calling Task.Factory.FromAsync(...) to get a Task<PSObject> for the asynchronous operation, then using await.

answered Jul 14, 2013 at 15:09

SLaks

891k182 gold badges1.9k silver badges2k bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ryan Currah Over a year ago

Forgive my ignorance, my understanding of making the method async dont I just make the method start like... public async static Task<string> RunScriptAsync(string scriptText)

SLaks Over a year ago

@user1843359: Yes, and use the await keyword to wait for asynchronous operations to finish.

Sebastian Over a year ago

I had results with: await Task.Factory.FromAsync(_ps.BeginInvoke(), pResult => _ps.EndInvoke(pResult));

Tom Gordon · Accepted Answer · 2023-03-09 15:38:54Z

0

This may not have been available when this post was made, but considering it is a top google search result it may be helpful to know that there is now an InvokeAsync command.

PSDataCollection<PSObject> connectionResult = await ps1.InvokeAsync();

answered Mar 9, 2023 at 15:38

Tom Gordon

5652 gold badges8 silver badges16 bronze badges

Collectives™ on Stack Overflow

How to create C# async powershell method?

2 Answers 2

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related