Skip to content
DocsTry Aspire
DocsTry

SqlServerBuilderExtensions Methods

ClassMethods2 members
Provides extension methods for adding SqlServer resources to an Hosting.IDistributedApplicationBuilder.
WithAdminer(IResourceBuilder<SqlServerServerResource>, Action<IResourceBuilder<AdminerContainerResource>>, string?)Section titled WithAdminer(IResourceBuilder<SqlServerServerResource>, Action<IResourceBuilder<AdminerContainerResource>>, string?)extensionIResourceBuilder<SqlServerServerResource>
Adds an administration and development platform for SqlServer to the application model using Adminer.
public static class SqlServerBuilderExtensions
{
public static IResourceBuilder<SqlServerServerResource> WithAdminer(
this IResourceBuilder<SqlServerServerResource> builder,
Action<IResourceBuilder<AdminerContainerResource>>? configureContainer = null,
string? containerName = null)
{
// ...
}
}
builderIResourceBuilder<SqlServerServerResource>The SqlServer server resource builder.
configureContainerAction<IResourceBuilder<AdminerContainerResource>>optionalConfiguration callback for Adminer container resource.
containerNamestring?optionalThe name of the container (Optional).
IResourceBuilder<SqlServerServerResource>A reference to the ApplicationModel.IResourceBuilder`1.
This version of the package defaults to the tag of the container image. This overload is not available in polyglot app hosts. Use SqlServerBuilderExtensions.WithAdminer instead.

Use in application host with a SqlServer resource

var builder = DistributedApplication.CreateBuilder(args);
var sqlserver = builder.AddSqlServer("sqlserver")
.WithAdminer();
var db = sqlserver.AddDatabase("db");
var api = builder.AddProject<Projects.Api>("api")
.WithReference(db);
builder.Build().Run();
WithDbGate(IResourceBuilder<SqlServerServerResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?)Section titled WithDbGate(IResourceBuilder<SqlServerServerResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?)extensionIResourceBuilder<SqlServerServerResource>
Adds an administration and development platform for SqlServer to the application model using DbGate.
public static class SqlServerBuilderExtensions
{
public static IResourceBuilder<SqlServerServerResource> WithDbGate(
this IResourceBuilder<SqlServerServerResource> builder,
Action<IResourceBuilder<DbGateContainerResource>>? configureContainer = null,
string? containerName = null)
{
// ...
}
}
builderIResourceBuilder<SqlServerServerResource>The SqlServer server resource builder.
configureContainerAction<IResourceBuilder<DbGateContainerResource>>optionalConfiguration callback for DbGate container resource.
containerNamestring?optionalThe name of the container (Optional).
IResourceBuilder<SqlServerServerResource>A reference to the ApplicationModel.IResourceBuilder`1.
This version of the package defaults to the tag of the container image. This overload is not available in polyglot app hosts. Use SqlServerBuilderExtensions.WithDbGate instead.

Use in application host with a SqlServer resource

var builder = DistributedApplication.CreateBuilder(args);
var sqlserver = builder.AddSqlServer("sqlserver")
.WithDbGate();
var db = sqlserver.AddDatabase("db");
var api = builder.AddProject<Projects.Api>("api")
.WithReference(db);
builder.Build().Run();