DevTunnelsResourceBuilderExtensions Methods

AddDevTunnel(IDistributedApplicationBuilder, string, string?, DevTunnelOptions?)extensionIResourceBuilder<DevTunnelResource>

Adds a dev tunnel resource to the application model.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> AddDevTunnel(
        this IDistributedApplicationBuilder builder,
        string name,
        string? tunnelId = null,
        DevTunnelOptions? options = null)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L55-L235

Parameters

builderIDistributedApplicationBuilder

namestring

tunnelIdstring?optional

optionsDevTunnelOptions?optional

Remarks

Dev tunnels can be used to expose local endpoints to the public internet via a secure tunnel. By default, the tunnel requires authentication, but anonymous access can be enabled via DevTunnelsResourceBuilderExtensions.WithAnonymousAccess. This overload is not available in polyglot app hosts. Use DevTunnelsResourceBuilderExtensions.AddDevTunnelForPolyglot instead.

Examples

The following example shows how to create a dev tunnel resource that exposes all endpoints on a web application project and enable anonymous access:

var builder = DistributedApplication.CreateBuilder(args);
var web = builder.AddProject<Projects.WebApp>("web");
var tunnel = builder.AddDevTunnel("mytunnel")
    .WithReference(web)
    .WithAnonymousAccess();
builder.Build().Run();

GetEndpoint(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, string)extensionEndpointReference

Gets the tunnel endpoint reference for the specified target resource and endpoint.

public static class DevTunnelsResourceBuilderExtensions
{
    public static EndpointReference GetEndpoint<TResource>(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        IResourceBuilder<TResource> resourceBuilder,
        string endpointName)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L387-L391

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The dev tunnel resource builder.

resourceBuilderIResourceBuilder<TResource>The target resource builder.

endpointNamestringThe name of the endpoint on the target resource.

Returns

EndpointReferenceAn ApplicationModel.EndpointReference representing the public tunnel endpoint.

Exceptions

InvalidOperationExceptionThrown when the specified endpoint is not found in the tunnel.

Remarks

This method is not available in polyglot app hosts. Use DevTunnelsResourceBuilderExtensions.GetEndpoint instead.

GetEndpoint(IResourceBuilder<DevTunnelResource>, IResource, string)extensionEndpointReference

Gets the tunnel endpoint reference for the specified target resource and endpoint.

public static class DevTunnelsResourceBuilderExtensions
{
    public static EndpointReference GetEndpoint(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        IResource resource,
        string endpointName)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L407-L419

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The dev tunnel resource builder.

resourceIResourceThe target resource.

endpointNamestringThe name of the endpoint on the target resource.

Returns

EndpointReferenceAn ApplicationModel.EndpointReference representing the public tunnel endpoint.

Remarks

This method is not available in polyglot app hosts. Use DevTunnelsResourceBuilderExtensions.GetEndpoint instead.

GetEndpoint(IResourceBuilder<DevTunnelResource>, EndpointReference)extensionEndpointReference

Gets the tunnel endpoint reference for the specified target endpoint.

public static class DevTunnelsResourceBuilderExtensions
{
    public static EndpointReference GetEndpoint(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        EndpointReference targetEndpointReference)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L431-L443

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The dev tunnel resource builder.

targetEndpointReferenceEndpointReferenceThe target endpoint reference.

Returns

EndpointReferenceAn ApplicationModel.EndpointReference representing the public tunnel endpoint.

WithAnonymousAccess(IResourceBuilder<DevTunnelResource>)extensionIResourceBuilder<DevTunnelResource>

Allows the tunnel to be publicly accessed without authentication.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithAnonymousAccess(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L367-L368

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

Remarks

Sets DevTunnelOptions.AllowAnonymous to true on DevTunnelResource.Options .

WithReference(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, bool)extensionIResourceBuilder<DevTunnelResource>

Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithReference<TResource>(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        IResourceBuilder<TResource> resourceBuilder,
        bool allowAnonymous)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L270-L273

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

resourceBuilderIResourceBuilder<TResource>The resource builder for the referenced resource.

allowAnonymousboolWhether anonymous access is allowed.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

WithReference(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, DevTunnelPortOptions?)extensionIResourceBuilder<DevTunnelResource>

Adds ports on the dev tunnel for all endpoints found on the referenced resource.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithReference<TResource>(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        IResourceBuilder<TResource> resourceBuilder,
        DevTunnelPortOptions? portOptions = null)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L294-L302

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

resourceBuilderIResourceBuilder<TResource>The resource builder for the referenced resource.

portOptionsDevTunnelPortOptions?optionalOptions for the dev tunnel ports.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

Remarks

This overload is not available in polyglot app hosts. Use the overload that accepts a bool allowAnonymous parameter instead. To expose only specific endpoints on the referenced resource, use DevTunnelsResourceBuilderExtensions.WithReference.

WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference)extensionIResourceBuilder<DevTunnelResource>

Exposes the specified endpoint via the dev tunnel.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithReference(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        EndpointReference targetEndpoint)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L316

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

targetEndpointEndpointReferenceThe endpoint to expose via the dev tunnel.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, bool)extensionIResourceBuilder<DevTunnelResource>

Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithReference(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        EndpointReference targetEndpoint,
        bool allowAnonymous)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L330

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

targetEndpointEndpointReferenceThe endpoint to expose via the dev tunnel.

allowAnonymousboolWhether anonymous access is allowed.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, DevTunnelPortOptions?)extensionIResourceBuilder<DevTunnelResource>

Exposes the specified endpoint via the dev tunnel.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<DevTunnelResource> WithReference(
        this IResourceBuilder<DevTunnelResource> tunnelBuilder,
        EndpointReference targetEndpoint,
        DevTunnelPortOptions? portOptions)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L348-L353

Parameters

tunnelBuilderIResourceBuilder<DevTunnelResource>The resource builder.

targetEndpointEndpointReferenceThe endpoint to expose via the dev tunnel.

portOptionsDevTunnelPortOptions?Options for the dev tunnel port.

Returns

IResourceBuilder<DevTunnelResource>The resource builder.

Remarks

This overload is not available in polyglot app hosts. Use DevTunnelsResourceBuilderExtensions.WithReference or DevTunnelsResourceBuilderExtensions.WithReference instead.

WithReference(IResourceBuilder<TResource>, IResourceBuilder<IResourceWithEndpoints>, IResourceBuilder<DevTunnelResource>)

extensionIResourceBuilder<TResource>

Injects service discovery and endpoint information as environment variables from the dev tunnel resource into the destination resource, using the tunneled resource's name as the service name. Each endpoint defined on the target resource will be injected using the format defined by the ApplicationModel.ReferenceEnvironmentInjectionAnnotation on the destination resource, i.e. either "services__{sourceResourceName}__{endpointScheme}__{endpointIndex}={uriString}" for .NET service discovery, or "{RESOURCE_ENDPOINT}={uri}" for endpoint injection.

public static class DevTunnelsResourceBuilderExtensions
{
    public static IResourceBuilder<TResource> WithReference<TResource>(
        this IResourceBuilder<TResource> builder,
        IResourceBuilder<IResourceWithEndpoints> targetResource,
        IResourceBuilder<DevTunnelResource> tunnelResource)
    {
        // ...
    }
}

DevTunnelResourceBuilderExtensions.cs#L472-L531

Parameters

builderIResourceBuilder<TResource>The builder.

targetResourceIResourceBuilder<IResourceWithEndpoints>The resource to inject service discovery information for.

tunnelResourceIResourceBuilder<DevTunnelResource>The dev tunnel resource to resolve the tunnel address from.

Returns

IResourceBuilder<TResource>The builder.

Remarks

Referencing a dev tunnel will delay the start of the resource until the referenced dev tunnel's endpoint is allocated. This method is not available in polyglot app hosts.