CommunityToolkit.Aspire.Hosting.PowerShell 17.0.0-beta.1018

Prefix Reserved

This is a prerelease version of CommunityToolkit.Aspire.Hosting.PowerShell.

dotnet add package CommunityToolkit.Aspire.Hosting.PowerShell --version 17.0.0-beta.1018

NuGet\Install-Package CommunityToolkit.Aspire.Hosting.PowerShell -Version 17.0.0-beta.1018

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="CommunityToolkit.Aspire.Hosting.PowerShell" Version="17.0.0-beta.1018" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="CommunityToolkit.Aspire.Hosting.PowerShell" Version="17.0.0-beta.1018" />
                    

                            Directory.Packages.props

<PackageReference Include="CommunityToolkit.Aspire.Hosting.PowerShell" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add CommunityToolkit.Aspire.Hosting.PowerShell --version 17.0.0-beta.1018

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: CommunityToolkit.Aspire.Hosting.PowerShell, 17.0.0-beta.1018"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package CommunityToolkit.Aspire.Hosting.PowerShell@17.0.0-beta.1018

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=CommunityToolkit.Aspire.Hosting.PowerShell&version=17.0.0-beta.1018&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=CommunityToolkit.Aspire.Hosting.PowerShell&version=17.0.0-beta.1018&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

CommunityToolkit Aspire PowerShell Scripting

About

Script your resources, use the pwsh (powershell core) engine and reference connectionstring expressions, live resources, dotnet instances or whatever else is in scope for your AppHost.

using CommunityToolkit.Aspire.Hosting.PowerShell;

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator();
var blob = storage.AddBlobs("myblob");

var ps = builder.AddPowerShell("ps")
    .WithReference(blob)
    .WaitFor(storage);

// uploads the script in scripts/
var script1 = ps.AddScript("script1", """
    param($name)

    write-information "Hello, $name"

    # uncommenting this will hang the script if you don't attach the pwsh debugger
    # wait-debugger

    write-information "`$myblob is $myblob"

    az storage container create --connection-string $myblob -n demo
    az storage blob upload --connection-string $myblob -c demo --file ./scripts/script.ps1
    
    write-information $pwd

    write-information "Blob uploaded"
""").WithArgs("world");

// outputs "the sum of 2 and 3 is 5"
var script2 = ps.AddScript("script2", """
    & ./scripts/script.ps1 @args
    """)
    .WithArgs(2, 3)
    .WaitForCompletion(script1);

builder.Build().Run();

Debugging

While your Apphost is running a script that is waiting via Wait-Debugger, open a terminal with powershell (pwsh) 7.4 or later (win, osx, linux) and use Get-PSHostProcessInfo, Enter-PSHostProcess, Get-Runspace and Debug-Runspace to connect the debugger.

See https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/enter-pshostprocess?view=powershell-7.5 for more information.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Aspire.Hosting (>= 17.0.0-preview.1.26555.3)
- JsonSchema.Net (>= 9.4.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.14)
- Microsoft.PowerShell.SDK (>= 7.4.10)
- System.Security.Cryptography.Pkcs (>= 10.0.14)
- System.Security.Cryptography.Xml (>= 8.0.5)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.