Get started with the Azure SQL Database integration

Azure SQL is a family of relational database management systems that run in the Azure cloud. The database systems are Platform-as-a-Service (PaaS) products that enable database administrators to implement highly scalable and available databases without maintaining complex infrastructures themselves. The Aspire Azure SQL Server Hosting integration provides methods to create a new Azure Database server and databases from code in your Aspire AppHost project.

In this introduction, you’ll see how to install and use the Aspire Azure SQL Database integrations in a simple configuration. If you already have this knowledge, see Azure SQL Database Hosting integration for full reference details.

ノート

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

Set up hosting integration

To begin, install the Aspire Azure SQL Database Hosting integration in your Aspire AppHost project. This integration allows you to create and manage Azure SQL Database resources from your Aspire hosting projects:

Aspire CLI

Aspire CLI — Aspire.Hosting.Azure.Sql パッケージを追加

aspire add azure-sql

Aspire CLI は対話的です。求められたら適切な結果を選択してください:

Aspire CLI — 出力例

Select an integration to add:

> azure-sql (Aspire.Hosting.Azure.Sql)
> Other results listed as selectable options...

ノート

結果が 1 つだけなら自動的に選択されます。バージョンは確認が必要です。

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Azure.Sql@*

PackageReference (*.csproj)

XML — Aspire.Hosting.Azure.Sql パッケージ参照を追加

<PackageReference Include="Aspire.Hosting.Azure.Sql" Version="*" />

Next, in the AppHost project, create an Azure SQL Database resource and pass it to the consuming client projects:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var azureSql = builder.AddAzureSqlServer("azuresql")
    .AddDatabase("database");

var myService = builder.AddProject<Projects.MyService>()
    .WithReference(azureSql);

// After adding all resources, run the app...

builder.Build().Run();

The preceding code adds an Azure SQL server resource named azuresql to the AppHost project, adds a database to it, and passes the database connection information to the consuming project.

注意

When you call AddAzureSqlServer, it implicitly calls AddAzureProvisioning—which adds support for generating Azure resources dynamically during app startup. The app must configure the appropriate subscription and location. For more information, see Local provisioning: Configuration.

ヒント

This is the simplest implementation of Azure SQL Database resources in the AppHost. There are many more options you can choose from to address your requirements. For full details, see Azure SQL Database Hosting integration.

Set up client integration

To use Azure SQL Database from your client applications, install the Aspire SQL Server client integration in your client project:

.NET CLI

.NET CLI — Add Aspire.Microsoft.Data.SqlClient package

dotnet add package Aspire.Microsoft.Data.SqlClient

Program.cs (C# file-based app)

Program.cs

#:package Aspire.Microsoft.Data.SqlClient@*

PackageReference (*.csproj)

XML — Add Aspire.Microsoft.Data.SqlClient package reference

<PackageReference Include="Aspire.Microsoft.Data.SqlClient" Version="*" />

In the Program.cs file of your client-consuming project, call the AddSqlServerClient extension method to register a SqlConnection for use via the dependency injection container:

builder.AddSqlServerClient(connectionName: "database");

Tip

The connectionName parameter must match the name used when adding the SQL database resource in the AppHost project.

Use injected Azure SQL Database properties

In the AppHost, when you used the WithReference method to pass an Azure SQL Database resource to a consuming client project, Aspire injects several configuration properties that you can use in the consuming project.

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Host property of a resource called database becomes DATABASE_HOST.

Use the GetValue() method to obtain these environment variables in consuming projects:

C# — Obtain configuration properties

string sqlHost = builder.Configuration.GetValue<string>("DATABASE_HOST");
string sqlPort = builder.Configuration.GetValue<string>("DATABASE_PORT");
string databaseName = builder.Configuration.GetValue<string>("DATABASE_DATABASENAME");

ヒント

The full set of properties that Aspire injects depends on whether you passed an Azure SQL Server or database resource. For more information, see Properties of the Azure SQL Database resources.

Add Azure SQL Database resources in client code

After adding the SqlConnection, you can retrieve the connection instance using dependency injection:

public class ExampleService(SqlConnection connection)
{
    // Use connection...
}

For full details on using the client integration, see Azure SQL Database Client integration.

Next steps

Azure SQL Database Hosting integration Learn more about the hosting integration features and capabilities

Azure SQL Database Client integration Learn how to use the Azure SQL Database client integration