DevTunnelResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.DevTunnels / DevTunnelResource

DevTunnelResource

Docs Reference TypeScript APIs Aspire.Hosting.DevTunnels DevTunnelResource

Handle TypeScript

📦 Aspire.Hosting.DevTunnels v13.2.0-preview.1.26159.1

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;
}

Implements

• IComputeResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport

Search members of DevTunnelResource…

method

5 members Clear filters

Methods

method getTunnelEndpoint

Gets the public endpoint exposed by the dev tunnel.

getTunnelEndpoint(targetEndpointReference: EndpointReference): EndpointReference

Parameters

targetEndpointReference EndpointReference

Returns

EndpointReference

method withAnonymousAccess builder

Configures the dev tunnel to allow anonymous access.

withAnonymousAccess(): DevTunnelResource

Returns

DevTunnelResource

method withTunnelReference builder

Configures the dev tunnel to expose a target endpoint.

withTunnelReference(targetEndpoint: EndpointReference): DevTunnelResource

Parameters

targetEndpoint EndpointReference

Returns

DevTunnelResource

method withTunnelReferenceAll builder

Configures the dev tunnel to expose all endpoints on the referenced resource.

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

Parameters

resourceBuilder IResourceWithEndpoints

allowAnonymous boolean

Returns

DevTunnelResource

method withTunnelReferenceAnonymous builder

Configures the dev tunnel to expose a target endpoint with access control.

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

Parameters

targetEndpoint EndpointReference

allowAnonymous boolean

Returns

DevTunnelResource