Skip to content
Docs Try Aspire

ActiveMQBuilderExtensions Methods

Class Methods 6 members
Provides extension methods for adding ActiveMQ resources to an Hosting.IDistributedApplicationBuilder.
AddActiveMQ(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, int?, string, int?) Section titled AddActiveMQ(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, int?, string, int?) extension IResourceBuilder<ActiveMQServerResource>
Adds a ActiveMQ container to the application model.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<ActiveMQServerResource> AddActiveMQ(
this IDistributedApplicationBuilder builder,
string name,
IResourceBuilder<ParameterResource>? userName = null,
IResourceBuilder<ParameterResource>? password = null,
int? port = null,
string scheme = "tcp",
int? webPort = null)
{
// ...
}
}
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.
name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.
userName IResourceBuilder<ParameterResource> optional The parameter used to provide the username for the ActiveMQ resource. If null a default value will be used.
password IResourceBuilder<ParameterResource> optional The parameter used to provide the password for the ActiveMQ resource. If null a random password will be generated.
port int? optional The host port that the underlying container is bound to when running locally.
scheme string optional The scheme of the endpoint, e.g. tcp or activemq (for masstransit). Defaults to tcp.
webPort int? optional The host port that the underlying webconsole is bound to when running locally.
IResourceBuilder<ActiveMQServerResource> A reference to the ApplicationModel.IResourceBuilder`1.
The default image and tag are "apache/activemq-classic" and "6.1.7".
AddActiveMQArtemis(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, int?, string, int?) Section titled AddActiveMQArtemis(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, int?, string, int?) extension IResourceBuilder<ActiveMQArtemisServerResource>
Adds a ActiveMQ Artemis container to the application model.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<ActiveMQArtemisServerResource> AddActiveMQArtemis(
this IDistributedApplicationBuilder builder,
string name,
IResourceBuilder<ParameterResource>? userName = null,
IResourceBuilder<ParameterResource>? password = null,
int? port = null,
string scheme = "tcp",
int? webPort = null)
{
// ...
}
}
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.
name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.
userName IResourceBuilder<ParameterResource> optional The parameter used to provide the username for the ActiveMQ resource. If null a default value will be used.
password IResourceBuilder<ParameterResource> optional The parameter used to provide the password for the ActiveMQ resource. If null a random password will be generated.
port int? optional The host port that the underlying container is bound to when running locally.
scheme string optional The scheme of the endpoint, e.g. tcp or activemq (for masstransit). Defaults to tcp.
webPort int? optional The host port that the underlying webconsole is bound to when running locally.
IResourceBuilder<ActiveMQArtemisServerResource> A reference to the ApplicationModel.IResourceBuilder`1.
The default image and tag are "apache/activemq-artemis" and "2.42.0".
WithConfBindMount(IResourceBuilder<T>, string, bool) Section titled WithConfBindMount(IResourceBuilder<T>, string, bool) extension IResourceBuilder<T>
Adds a bind mount for the conf folder to a ActiveMQ container resource.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<T> WithConfBindMount<T>(
this IResourceBuilder<T> builder,
string source,
bool isReadOnly = false)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
source string The source directory on the host to mount into the container.
isReadOnly bool optional A flag that indicates if this is a read-only mount.
IResourceBuilder<T> The ApplicationModel.IResourceBuilder`1.
WithConfVolume(IResourceBuilder<T>, string?, bool) Section titled WithConfVolume(IResourceBuilder<T>, string?, bool) extension IResourceBuilder<T>
Adds a named volume for the config folder to a ActiveMQ container resource.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<T> WithConfVolume<T>(
this IResourceBuilder<T> builder,
string? name = null,
bool isReadOnly = false)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
name string? optional The name of the volume. Defaults to an auto-generated name based on the application and resource names.
isReadOnly bool optional A flag that indicates if this is a read-only volume.
IResourceBuilder<T> The ApplicationModel.IResourceBuilder`1.
WithDataBindMount(IResourceBuilder<T>, string, bool) Section titled WithDataBindMount(IResourceBuilder<T>, string, bool) extension IResourceBuilder<T>
Adds a bind mount for the data folder to a ActiveMQ container resource.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<T> WithDataBindMount<T>(
this IResourceBuilder<T> builder,
string source,
bool isReadOnly = false)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
source string The source directory on the host to mount into the container.
isReadOnly bool optional A flag that indicates if this is a read-only mount.
IResourceBuilder<T> The ApplicationModel.IResourceBuilder`1.
WithDataVolume(IResourceBuilder<T>, string?, bool) Section titled WithDataVolume(IResourceBuilder<T>, string?, bool) extension IResourceBuilder<T>
Adds a named volume for the data folder to a ActiveMQ container resource.
public static class ActiveMQBuilderExtensions
{
public static IResourceBuilder<T> WithDataVolume<T>(
this IResourceBuilder<T> builder,
string? name = null,
bool isReadOnly = false)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
name string? optional The name of the volume. Defaults to an auto-generated name based on the application and resource names.
isReadOnly bool optional A flag that indicates if this is a read-only volume.
IResourceBuilder<T> The ApplicationModel.IResourceBuilder`1.