Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

NgrokResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Ngrok v13.6.1
type NgrokResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Methods

methodWithAuthTokenbuilder
Adds a ngrok auth token to a ngrok resource.
WithAuthToken(ngrokAuthToken ParameterResource) NgrokResource
ngrokAuthTokenParameterResourceThe ngrok auth token as a parameter resource.
NgrokResource

The same reference to ngrok resource builder.

Returns a handle; failures surface later via Err().

methodWithAuthTokenValuebuilder
Adds a ngrok auth token to a ngrok resource.
WithAuthTokenValue(ngrokAuthToken string) NgrokResource
ngrokAuthTokenstringThe ngrok auth token.
NgrokResource

The same reference to ngrok resource builder.

Returns a handle; failures surface later via Err().

methodWithTunnelEndpointbuilder
Configures a resource with endpoints as a ngrok tunnel endpoint.
WithTunnelEndpoint(
resource ResourceWithEndpoints,
endpointName string,
options ...*WithTunnelEndpointOptions,
) NgrokResource
resourceResourceWithEndpointsThe resource whose endpoint should be exposed through ngrok.
endpointNamestringThe endpoint name to expose.
options...*WithTunnelEndpointOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithTunnelEndpointOptions argument.

NgrokUrl*stringThe ngrok URL to use, or null to allow ngrok to choose one.
Labelsmap[string]stringOptional endpoint labels.
NgrokResource

The same reference to ngrok resource builder.

Returns a handle; failures surface later via Err().