CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder 9.2.2-beta.218

Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder.
There is a newer version of this package available.
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder --version 9.2.2-beta.218
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder -Version 9.2.2-beta.218
                    
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.Azure.DataApiBuilder" Version="9.2.2-beta.218" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder" Version="9.2.2-beta.218" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder" />
                    
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.Azure.DataApiBuilder --version 9.2.2-beta.218
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder, 9.2.2-beta.218"
                    
#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.Azure.DataApiBuilder@9.2.2-beta.218
                    
#: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.Azure.DataApiBuilder&version=9.2.2-beta.218&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder&version=9.2.2-beta.218&prerelease
                    
Install as a Cake Tool

CommunityToolkit.Hosting.Azure.DataApiBuilder

Overview

This .NET Aspire Integration runs Data API builder in a container. Data API builder generates secure, feature-rich REST and GraphQL endpoints for Tables, Views and Stored Procedures performing CRUD (Create, Read, Update, Delete, Execute) operations against Azure SQL Database, SQL Server, PostgreSQL, MySQL and Azure CosmosDB.

Usage

Example 1: Single data source

var builder = DistributedApplication.CreateBuilder(args);

var sqlDatabase = builder
    .AddSqlServer("your-server-name")
    .AddDatabase("your-database-name");

var dab = builder.AddDataAPIBuilder("dab")
    .WithReference(sqlDatabase)
    .WaitFor(sqlDatabase);

var app = builder
    .AddProject<Projects.Client>()
    .WithReference(dab);

builder.Build().Run();

Example 2: Multiple data sources

var builder = DistributedApplication.CreateBuilder(args);

var sqlDatabase1 = builder
    .AddSqlServer("your-server-name")
    .AddDatabase("your-database-name");

var sqlDatabase2 = builder
    .AddSqlServer("your-server-name")
    .AddDatabase("your-database-name");

var dab = builder.AddDataAPIBuilder("dab", 
        "./dab-config-1.json", 
        "./dab-config-2.json")
    .WithReference(sqlDatabase1)
    .WithReference(sqlDatabase2)
    .WaitFor(sqlDatabase1)
    .WaitFor(sqlDatabase2);

var app = builder
    .AddProject<Projects.Client>()
    .WithReference(dab);

builder.Build().Run();

Note: All files are mounted/copied to the same /App folder.

Example 3: Cosmos DB and a schema file

var builder = DistributedApplication.CreateBuilder(args);

var cosmosdb = builder
    .AddAzureCosmosDB("myNewCosmosAccountName")
    .AddDatabase("myCosmosDatabaseName");

var dab = builder.AddDataAPIBuilder("dab",
        "./dab-config.json",
        "./schema.graphql")
    .WithReference(cosmosdb)
    .WaitFor(cosmosdb);

var app = builder
    .AddProject<Projects.Client>()
    .WithReference(dab);

builder.Build().Run();

Example 4: Connection string-only

var builder = DistributedApplication.CreateBuilder(args);

var sqlDatabase = builder
    .AddConnectionString("your-cs-name");

var dab = builder.AddDataAPIBuilder("dab")
    .WithReference(sqlDatabase);

var app = builder
    .AddProject<Projects.Client>()
    .WithReference(dab);

builder.Build().Run();

Configuration

  • name - The name of the resource.
  • port - The optional port number for the Data API builder container. Defaults to random.
  • configFilePaths - Opiotnal paths to the config/schema file(s) for Data API builder. Default is ./dab-config.json.

Data API builder Container Image Configuration

You can specify custom registry/image/tag values by using the WithImageRegistry/WithImage/WithImageTag methods:

var dab = builder.AddDataAPIBuilder("dab")
    .WithImageRegistry("mcr.microsoft.com")
    .WithImage("azure-databases/data-api-builder")
    .WithImageTag("latest");

Known Issues

The current imlpementation of the Data API builder .NET Aspire integration does not support HTTPS endpoints. However, this is only a dev-time consideration. Service discovery when published can use HTTPS without any problems.

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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.8.0 193 9/26/2025
9.8.0-beta.402 119 9/29/2025
9.8.0-beta.401 114 9/29/2025
9.8.0-beta.399 115 9/26/2025
9.8.0-beta.398 120 9/25/2025
9.8.0-beta.397 122 9/25/2025
9.8.0-beta.395 113 9/24/2025
9.8.0-beta.394 121 9/23/2025
9.8.0-beta.393 127 9/23/2025
9.8.0-beta.392 120 9/23/2025
9.8.0-beta.389 243 9/18/2025
9.8.0-beta.388 252 9/16/2025
9.8.0-beta.386 194 9/15/2025
9.8.0-beta.385 197 9/15/2025
9.8.0-beta.384 44 9/13/2025
9.8.0-beta.376 128 9/8/2025
9.8.0-beta.375 53 9/6/2025
9.8.0-beta.373 133 9/5/2025
9.8.0-beta.372 130 9/4/2025
9.8.0-beta.370 122 9/2/2025
9.8.0-beta.364 118 9/1/2025
9.7.2 307 8/29/2025
9.7.2-beta.362 161 8/29/2025
9.7.2-beta.361 163 8/29/2025
9.7.2-beta.360 163 8/29/2025
9.7.2-beta.359 163 8/28/2025
9.7.2-beta.358 162 8/28/2025
9.7.2-beta.357 165 8/28/2025
9.7.1 215 8/27/2025
9.7.1-beta.355 166 8/27/2025
9.7.1-beta.354 169 8/27/2025
9.7.1-beta.353 167 8/27/2025
9.7.1-beta.352 168 8/27/2025
9.7.1-beta.351 170 8/27/2025
9.7.1-beta.348 134 8/14/2025
9.7.1-beta.344 75 8/10/2025
9.7.1-beta.343 196 8/8/2025
9.7.1-beta.342 200 8/7/2025
9.7.1-beta.341 200 8/6/2025
9.7.1-beta.340 192 8/5/2025
9.7.1-beta.339 185 8/5/2025
9.7.0 165 8/1/2025
9.7.0-beta.337 84 8/1/2025
9.7.0-beta.336 92 8/1/2025
9.7.0-beta.335 94 8/1/2025
9.7.0-beta.333 99 7/30/2025
9.6.1-beta.332 95 7/30/2025
9.6.1-beta.331 97 7/30/2025
9.6.1-beta.330 94 7/30/2025
9.6.1-beta.329 95 7/30/2025
9.6.1-beta.328 132 7/29/2025
9.6.1-beta.327 112 7/28/2025
9.6.1-beta.326 112 7/28/2025
9.6.0 220 7/10/2025
9.6.0-beta.324 125 7/10/2025
9.5.1-beta.323 126 7/10/2025
9.5.1-beta.322 124 7/10/2025
9.5.1-beta.321 130 7/10/2025
9.5.1-beta.320 127 7/9/2025
9.5.1-beta.319 125 7/8/2025
9.5.1-beta.318 130 7/2/2025
9.5.1-beta.317 123 6/30/2025
9.5.1-beta.315 124 6/26/2025
9.5.1-beta.314 143 6/23/2025
9.5.1-beta.313 114 6/20/2025
9.5.1-beta.312 136 6/20/2025
9.5.1-beta.311 142 6/18/2025
9.5.1-beta.310 124 6/17/2025
9.5.1-beta.309 136 6/17/2025
9.5.1-beta.308 127 6/17/2025
9.5.1-beta.307 142 6/16/2025
9.5.1-beta.306 283 6/11/2025
9.5.1-beta.305 94 6/7/2025
9.5.1-beta.304 126 6/6/2025
9.5.1-beta.303 145 6/4/2025
9.5.1-beta.302 124 6/4/2025
9.5.1-beta.301 141 6/2/2025
9.5.1-beta.300 144 5/28/2025
9.5.0 255 5/27/2025
9.5.0-beta.299 145 5/27/2025
9.5.0-beta.298 144 5/26/2025
9.5.0-beta.297 97 5/24/2025
9.5.0-beta.296 81 5/24/2025
9.5.0-beta.295 52 5/24/2025
9.4.1-beta.291 141 5/19/2025
9.4.1-beta.289 146 5/16/2025
9.4.1-beta.288 204 5/16/2025
9.4.1-beta.287 212 5/16/2025
9.4.1-beta.286 208 5/16/2025
9.4.1-beta.285 226 5/14/2025
9.4.1-beta.284 225 5/13/2025
9.4.1-beta.283 232 5/12/2025
9.4.1-beta.282 152 5/7/2025
9.4.1-beta.280 190 5/2/2025
9.4.1-beta.279 142 5/2/2025
9.4.1-beta.277 171 4/23/2025
9.4.1-beta.276 146 4/23/2025
9.4.1-beta.275 154 4/23/2025
9.4.1-beta.274 158 4/23/2025
9.4.1-beta.273 157 4/23/2025
9.4.1-beta.272 160 4/23/2025
9.4.1-beta.271 162 4/23/2025
9.4.1-beta.270 155 4/20/2025
9.4.0 304 4/20/2025
9.4.0-beta.269 171 4/20/2025
9.4.0-beta.268 159 4/20/2025
9.3.1-beta.267 160 4/20/2025
9.3.1-beta.266 87 4/19/2025
9.3.1-beta.265 169 4/15/2025
9.3.1-beta.264 184 4/15/2025
9.3.1-beta.263 190 4/15/2025
9.3.1-beta.262 188 4/15/2025
9.3.1-beta.260 170 4/10/2025
9.3.1-beta.259 172 4/8/2025
9.3.1-beta.258 143 4/8/2025
9.3.1-beta.257 160 4/8/2025
9.3.1-beta.256 163 4/8/2025
9.3.1-beta.255 163 4/8/2025
9.3.1-beta.254 170 4/8/2025
9.3.1-beta.253 145 4/1/2025
9.3.1-beta.252 126 3/27/2025
9.3.1-beta.250 142 3/27/2025
9.3.1-beta.249 149 3/27/2025
9.3.1-beta.248 122 3/27/2025
9.3.1-beta.247 137 3/27/2025
9.3.1-beta.244 487 3/25/2025
9.3.1-beta.242 477 3/24/2025
9.3.1-beta.241 153 3/19/2025
9.3.0 1,347 3/19/2025
9.3.0-beta.239 139 3/19/2025
9.2.2-beta.237 152 3/19/2025
9.2.2-beta.236 122 3/14/2025
9.2.2-beta.230 152 3/13/2025
9.2.2-beta.229 146 3/13/2025
9.2.2-beta.228 170 3/11/2025
9.2.2-beta.227 160 3/11/2025
9.2.2-beta.226 155 3/11/2025
9.2.2-beta.225 152 3/11/2025
9.2.2-beta.224 148 3/11/2025
9.2.2-beta.223 166 3/10/2025
9.2.2-beta.222 141 3/10/2025
9.2.2-beta.220 150 3/9/2025
9.2.2-beta.218 157 3/9/2025
9.2.2-beta.217 200 3/7/2025
9.2.2-beta.216 198 3/7/2025
9.2.2-beta.215 205 3/7/2025
9.2.2-beta.214 185 3/5/2025
9.2.2-beta.213 192 3/5/2025
9.2.2-beta.212 191 3/5/2025
9.2.2-beta.211 204 3/4/2025
9.2.2-beta.210 203 3/4/2025
9.2.2-beta.208 80 3/3/2025
9.2.1 207 3/3/2025
9.2.1-beta.207 127 3/2/2025
9.2.1-beta.206 100 3/1/2025
9.2.1-beta.205 93 2/27/2025
9.2.1-beta.204 90 2/26/2025
9.2.1-beta.203 87 2/26/2025
9.2.0 202 2/26/2025
9.2.0-beta.202 76 2/26/2025
9.2.0-beta.201 90 2/26/2025
9.2.0-beta.199 89 2/26/2025
9.2.0-beta.198 73 2/26/2025
9.1.1-beta.197 110 2/25/2025
9.1.1-beta.196 88 2/25/2025
9.1.1-beta.195 87 2/25/2025
9.1.1-beta.194 82 2/25/2025
9.1.1-beta.193 95 2/25/2025
9.1.1-beta.192 106 2/24/2025
9.1.1-beta.191 99 2/24/2025
9.1.1-beta.190 81 2/19/2025
9.1.1-beta.189 90 2/19/2025
9.1.1-beta.188 91 2/19/2025
9.1.1-beta.187 103 2/19/2025
9.1.1-beta.183 106 2/18/2025
9.1.1-beta.182 108 2/18/2025
9.1.1-beta.181 109 2/18/2025
9.1.1-beta.180 82 2/17/2025
9.1.1-beta.178 104 2/17/2025
9.1.1-beta.177 111 2/12/2025
9.1.1-beta.176 94 2/11/2025
9.1.1-beta.175 95 2/11/2025
9.1.1-beta.173 110 2/10/2025
9.1.1-beta.169 85 2/6/2025
9.1.1-beta.168 88 2/5/2025
9.1.1-beta.166 94 2/5/2025
9.1.1-beta.165 92 2/5/2025
9.1.1-beta.164 98 2/3/2025
9.1.1-beta.162 92 2/3/2025
9.1.1-beta.155 82 1/30/2025
9.1.1-beta.154 94 1/30/2025
9.1.1-beta.153 76 1/30/2025
9.1.1-beta.152 87 1/29/2025
9.1.1-beta.150 94 1/29/2025
9.1.1-beta.148 92 1/26/2025
9.1.1-beta.147 92 1/26/2025
9.1.1-beta.146 88 1/23/2025
9.1.1-beta.145 85 1/22/2025
9.1.1-beta.144 80 1/22/2025
9.1.1-beta.142 71 1/22/2025
9.1.1-beta.140 80 1/22/2025
9.1.1-beta.139 100 1/21/2025
9.1.1-beta.138 93 1/20/2025
9.1.1-beta.137 68 1/17/2025
9.1.1-beta.136 64 1/15/2025
9.1.1-beta.135 55 1/15/2025
9.1.1-beta.134 45 1/15/2025
9.1.1-beta.128 62 1/9/2025
9.1.1-beta.127 59 1/9/2025
9.1.1-beta.126 78 1/9/2025
9.1.1-beta.125 84 1/9/2025
9.1.1-beta.124 84 1/9/2025
9.1.0 494 12/12/2024
9.1.0-beta.123 96 1/3/2025
9.1.0-beta.122 95 1/3/2025
9.1.0-beta.121 93 1/2/2025
9.1.0-beta.120 79 12/30/2024
9.1.0-beta.119 86 12/30/2024
9.1.0-beta.118 87 12/30/2024
9.1.0-beta.116 89 12/30/2024
9.1.0-beta.114 92 12/30/2024
9.1.0-beta.113 73 12/30/2024
9.1.0-beta.112 83 12/18/2024
9.1.0-beta.110 83 12/16/2024
9.1.0-beta.109 98 12/12/2024
9.0.1-beta.108 101 12/12/2024
9.0.1-beta.107 77 12/11/2024
9.0.1-beta.106 95 12/12/2024
9.0.1-beta.104 73 12/11/2024
9.0.1-beta.102 78 12/6/2024
9.0.1-beta.99 94 12/6/2024
9.0.1-beta.98 74 12/6/2024
9.0.1-beta.95 97 12/5/2024
9.0.1-beta.94 86 12/5/2024
9.0.1-beta.93 97 12/2/2024
9.0.1-beta.92 85 11/30/2024
9.0.1-beta.91 90 11/30/2024
9.0.1-beta.90 87 11/29/2024
9.0.1-beta.89 104 11/29/2024
9.0.1-beta.88 88 11/27/2024
9.0.1-beta.87 84 11/27/2024
9.0.1-beta.86 98 11/27/2024
9.0.1-beta.84 79 11/24/2024
9.0.1-beta.83 96 11/22/2024
9.0.1-beta.82 82 11/21/2024
9.0.1-beta.81 77 11/19/2024
9.0.1-beta.80 79 11/19/2024
9.0.1-beta.79 88 11/19/2024
9.0.1-beta.77 101 11/15/2024
9.0.0 184 11/15/2024
9.0.0-beta.76 92 11/14/2024
9.0.0-beta.75 99 11/14/2024
9.0.0-beta.74 93 11/14/2024
9.0.0-beta.73 77 11/14/2024
9.0.0-beta.72 91 11/14/2024
9.0.0-beta.71 103 11/13/2024
9.0.0-beta.70 100 11/13/2024
9.0.0-beta.69 91 11/13/2024
9.0.0-beta.68 79 11/13/2024
9.0.0-beta.67 100 11/13/2024
9.0.0-beta.66 109 11/13/2024
9.0.0-beta.63 99 11/12/2024
9.0.0-beta.54 100 10/31/2024
1.0.0-beta.60 88 11/11/2024
1.0.0-beta.58 96 11/4/2024
1.0.0-beta.57 85 11/1/2024
1.0.0-beta.56 83 11/1/2024
1.0.0-beta.55 87 11/1/2024