Aspire.Hosting.Azure.KeyVault 9.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.Azure.KeyVault --version 9.0.0                

                    
                

            
NuGet\Install-Package Aspire.Hosting.Azure.KeyVault -Version 9.0.0
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="Aspire.Hosting.Azure.KeyVault" Version="9.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Aspire.Hosting.Azure.KeyVault --version 9.0.0                

                    
                

            
#r "nuget: Aspire.Hosting.Azure.KeyVault, 9.0.0"
#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. 
// Install Aspire.Hosting.Azure.KeyVault as a Cake Addin
#addin nuget:?package=Aspire.Hosting.Azure.KeyVault&version=9.0.0

// Install Aspire.Hosting.Azure.KeyVault as a Cake Tool
#tool nuget:?package=Aspire.Hosting.Azure.KeyVault&version=9.0.0

Azure Key Vault extensions library for .NET Aspire application model

Azure Key Vault is a cloud service that provides a secure storage of secrets, such as passwords and database connection strings.

The Azure Key Vault extensions library allows you to extend the .NET Aspire application model to support to provisioning Key Vaults as part of application development and testing.

Getting started

Prerequisites

  • Azure subscription - create one for free
  • A .NET Aspire project based on the starter template.

Install the package

Install the Azure Key Vault extensions library for .NET Aspire application model with NuGet:

dotnet add package Aspire.Hosting.Azure.KeyVault

Configure Azure Provisioning for local development

Adding Azure resources to the .NET Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.

{
    "Azure": {
      "SubscriptionId": "<your subscription id>",
      "ResourceGroupPrefix": "<prefix for the resource group>",
      "Location": "<azure location>"
    }
}

NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.

Usage examples

Adding a Key Vault resource to the .NET Aspire application model

In order to provision a Key Vault resource as part of a .NET Aspire application you need to add the resource via the IDistributedApplicationBuilder interface. The builder.AddAzureKeyVault(...) extension method is used to register a Key Vault resource with the application model. Then use the WithReference extension method on a resource to inject the necessary connection string information for accessing Key Vault into the application that depends on it.

var builder = DistributedApplication.CreateBuilder(args);
builder.AddAzureProvisioner();

var keyVault = builder.AddAzureKeyVault("mykeyvault");

builder.AddProject<Projects.MyApp>("myapp")
       .WithReference(keyVault);

Inside the the implementation of the application that depends on Key Vault (MyApp in this case) add the Aspire.Azure.Security.KeyVault package and follow the instructions in that package README to use the connection string that was injected by the code above.

Customizing the Azure Key Vault resource

The builder.AddAzureKeyVault(...) extension method has an overload that allows for customization of the Key Vault resource that is created. In the below example a .NET Aspire parameter is defined which is then assigned to the value of a Key Vault secret which is created at provisioning time.

var builder = DistributedApplication.CreateBuilder(args);
builder.AddAzureProvisioning();

var webhookSigningSharedSecret = builder.AddParameter("webhooksecret", secret: true);

var keyVault = builder.AddAzureKeyVault("mykeyvault", (_, construct, kv) => {

  // Create a secret and assign an parameter resource to its value.
  var secret = new KeyVaultSecret(construct, "secret");
  secret.AssignProperty(x => x.Properties.Value, webhookSigningSharedSecret);

});

builder.AddProject<Projects.MyApp>("myapp")
       .WithReference(keyVault);
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Aspire.Hosting.Azure.KeyVault:

Package Downloads
EAVFramework.Extensions.Aspire.Hosting

Aspire Hosting package for EAVFramework
Achieve.Aspire.AzureProvisioning

Adds support for more full-featured (and secure) Azure provisioning within for Aspire.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.0.0 448 11/12/2024
9.0.0-rc.1.24511.1 1,158 10/15/2024
8.2.2 2,579 10/24/2024
8.2.1 5,921 9/26/2024
8.2.0 11,557 8/29/2024
8.1.0 6,022 7/23/2024
8.0.2 3,450 6/28/2024
8.0.1 3,758 5/21/2024
8.0.0 148 5/21/2024
8.0.0-preview.7.24251.11 445 5/7/2024
8.0.0-preview.6.24214.1 311 4/23/2024
8.0.0-preview.5.24201.12 741 4/9/2024