DevTunnelResource

Handle

📦 Aspire.Hosting.DevTunnels v13.4.0

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

5 members

Methods

method getTunnelEndpoint

Gets the tunnel endpoint reference for the specified target endpoint.

getTunnelEndpoint(targetEndpointReference: EndpointReference): EndpointReference

Parameters

targetEndpointReference EndpointReference

Returns

EndpointReference

method withAnonymousAccess builder

Allows the tunnel to be publicly accessed without authentication.

withAnonymousAccess(): DevTunnelResource

Returns

DevTunnelResource

method withTunnelReference builder

Exposes the specified endpoint via the dev tunnel.

withTunnelReference(targetEndpoint: EndpointReference): DevTunnelResource

Parameters

targetEndpoint EndpointReference

Returns

DevTunnelResource

method withTunnelReferenceAll builder

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

resourceBuilder IResourceWithEndpoints

allowAnonymous boolean

Returns

DevTunnelResource

method withTunnelReferenceAnonymous builder

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

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

Parameters

targetEndpoint EndpointReference

allowAnonymous boolean

Returns

DevTunnelResource