DevTunnelResource

Handle

📦 Aspire.Hosting.DevTunnels v13.6.0

interface DevTunnelResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  getTunnelEndpoint(targetEndpointReference: EndpointReference): EndpointReference;
  withAnonymousAccess(): DevTunnelResource;
  withExpiration(expirationHours: number): DevTunnelResource;
  withTunnelReference(targetEndpoint: EndpointReference): DevTunnelResource;
  withTunnelReferenceAll(
      resourceBuilder: IResourceWithEndpoints,
      allowAnonymous: boolean): DevTunnelResource;
  withTunnelReferenceAnonymous(
      targetEndpoint: EndpointReference,
      allowAnonymous: boolean): DevTunnelResource;
}

6 members

Methods

methodgetTunnelEndpoint

Gets the tunnel endpoint reference for the specified target endpoint.

getTunnelEndpoint(targetEndpointReference: EndpointReference): EndpointReference

Parameters

targetEndpointReferenceEndpointReference

Returns

EndpointReference

methodwithAnonymousAccessbuilder

Allows the tunnel to be publicly accessed without authentication.

withAnonymousAccess(): DevTunnelResource

Returns

DevTunnelResource

methodwithExpirationbuilder

Configures how long the tunnel can remain unused or unmodified before it expires.

withExpiration(expirationHours: number): DevTunnelResource

Parameters

expirationHoursnumber

Returns

DevTunnelResource

methodwithTunnelReferencebuilder

Exposes the specified endpoint via the dev tunnel.

withTunnelReference(targetEndpoint: EndpointReference): DevTunnelResource

Parameters

targetEndpointEndpointReference

Returns

DevTunnelResource

methodwithTunnelReferenceAllbuilder

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

withTunnelReferenceAll(
    resourceBuilder: IResourceWithEndpoints,
    allowAnonymous: boolean): DevTunnelResource

Parameters

resourceBuilderIResourceWithEndpoints

allowAnonymousboolean

Returns

DevTunnelResource

methodwithTunnelReferenceAnonymousbuilder

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

withTunnelReferenceAnonymous(
    targetEndpoint: EndpointReference,
    allowAnonymous: boolean): DevTunnelResource

Parameters

targetEndpointEndpointReference

allowAnonymousboolean

Returns

DevTunnelResource