DistributedApplicationTestingBuilder Methods

Docs / Reference / Search C# APIs / Aspire.Hosting.Testing / DistributedApplicationTestingBuilder / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Testing DistributedApplicationTestingBuilder Methods

Class Methods 8 members

Methods for creating distributed application instances for testing purposes.

Create(string[]) static IDistributedApplicationTestingBuilder

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static IDistributedApplicationTestingBuilder Create(
        params string[] args)
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L126

Parameters

args string[] The command line arguments to pass to the entry point.

Returns

IDistributedApplicationTestingBuilder A new instance of IDistributedApplicationTestingBuilder.

Create(string[], Action<DistributedApplicationOptions, HostApplicationBuilderSettings>) static IDistributedApplicationTestingBuilder

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static IDistributedApplicationTestingBuilder Create(
        string[] args,
        Action<DistributedApplicationOptions, HostApplicationBuilderSettings> configureBuilder)
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L138-L141

Parameters

args string[] The command line arguments to pass to the entry point.

configureBuilder Action<DistributedApplicationOptions, HostApplicationBuilderSettings> The delegate used to configure the builder.

Returns

IDistributedApplicationTestingBuilder A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync<TEntryPoint>(
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L38

Parameters

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(Type, CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync(
        Type entryPoint,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L50

Parameters

entryPoint Type A type in the entry point assembly of the target Aspire AppHost. Typically, the Program class can be used.

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(string[], CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync<TEntryPoint>(
        string[] args,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L66

Parameters

args string[] The command line arguments to pass to the entry point.

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(Type, string[], CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync(
        Type entryPoint,
        string[] args,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L79

Parameters

entryPoint Type A type in the entry point assembly of the target Aspire AppHost. Typically, the Program class can be used.

args string[] The command line arguments to pass to the entry point.

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(string[], Action<DistributedApplicationOptions, HostApplicationBuilderSettings>, CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync<TEntryPoint>(
        string[] args,
        Action<DistributedApplicationOptions, HostApplicationBuilderSettings> configureBuilder,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs#L95

Parameters

args string[] The command line arguments to pass to the entry point.

configureBuilder Action<DistributedApplicationOptions, HostApplicationBuilderSettings> The delegate used to configure the builder.

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.

CreateAsync(Type, string[], Action<DistributedApplicationOptions, HostApplicationBuilderSettings>, CancellationToken) static Task<IDistributedApplicationTestingBuilder>

Creates a new instance of IDistributedApplicationTestingBuilder.

public static class DistributedApplicationTestingBuilder
{
    public static Task<IDistributedApplicationTestingBuilder> CreateAsync(
        Type entryPoint,
        string[] args,
        Action<DistributedApplicationOptions, HostApplicationBuilderSettings> configureBuilder,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationTestingBuilder.cs

Parameters

entryPoint Type A type in the entry point assembly of the target Aspire AppHost. Typically, the Program class can be used.

args string[] The command line arguments to pass to the entry point.

configureBuilder Action<DistributedApplicationOptions, HostApplicationBuilderSettings> The delegate used to configure the builder.

cancellationToken CancellationToken optional The Threading.CancellationToken.

Returns

Task<IDistributedApplicationTestingBuilder> A new instance of IDistributedApplicationTestingBuilder.