Aspire.Hosting.Azure.KeyVault
9.0.0-rc.1.24511.1
Prefix Reserved
See the version list below for details.
dotnet add package Aspire.Hosting.Azure.KeyVault --version 9.0.0-rc.1.24511.1
NuGet\Install-Package Aspire.Hosting.Azure.KeyVault -Version 9.0.0-rc.1.24511.1
<PackageReference Include="Aspire.Hosting.Azure.KeyVault" Version="9.0.0-rc.1.24511.1" />
paket add Aspire.Hosting.Azure.KeyVault --version 9.0.0-rc.1.24511.1
#r "nuget: Aspire.Hosting.Azure.KeyVault, 9.0.0-rc.1.24511.1"
// Install Aspire.Hosting.Azure.KeyVault as a Cake Addin #addin nuget:?package=Aspire.Hosting.Azure.KeyVault&version=9.0.0-rc.1.24511.1&prerelease // Install Aspire.Hosting.Azure.KeyVault as a Cake Tool #tool nuget:?package=Aspire.Hosting.Azure.KeyVault&version=9.0.0-rc.1.24511.1&prerelease
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 | Versions 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. |
-
net8.0
- Aspire.Hosting.Azure (>= 9.0.0-rc.1.24511.1)
- AspNetCore.HealthChecks.Uris (>= 8.0.1)
- Azure.Core (>= 1.44.0)
- Azure.Identity (>= 1.12.1)
- Azure.Provisioning (>= 1.0.0-beta.1)
- Azure.Provisioning.KeyVault (>= 1.0.0-beta.1)
- Azure.ResourceManager.Authorization (>= 1.1.3)
- Azure.ResourceManager.KeyVault (>= 1.3.0)
- Azure.ResourceManager.Resources (>= 1.9.0)
- Azure.Security.KeyVault.Secrets (>= 4.6.0)
- Google.Protobuf (>= 3.28.2)
- Grpc.AspNetCore (>= 2.66.0)
- Grpc.Net.ClientFactory (>= 2.66.0)
- Grpc.Tools (>= 2.66.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.1.1)
- KubernetesClient (>= 15.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.10)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Polly.Core (>= 8.4.2)
- System.IO.Hashing (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
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 | 9,080 | 11/12/2024 |
9.0.0-rc.1.24511.1 | 1,351 | 10/15/2024 |
8.2.2 | 3,903 | 10/24/2024 |
8.2.1 | 6,493 | 9/26/2024 |
8.2.0 | 13,294 | 8/29/2024 |
8.1.0 | 6,094 | 7/23/2024 |
8.0.2 | 3,470 | 6/28/2024 |
8.0.1 | 3,937 | 5/21/2024 |
8.0.0 | 174 | 5/21/2024 |
8.0.0-preview.7.24251.11 | 457 | 5/7/2024 |
8.0.0-preview.6.24214.1 | 319 | 4/23/2024 |
8.0.0-preview.5.24201.12 | 764 | 4/9/2024 |