Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AddNgrok

Method
📦 CommunityToolkit.Aspire.Hosting.Ngrok v13.6.1
func (DistributedApplicationBuilder) AddNgrok(
name string,
options ...*AddNgrokOptions,
) NgrokResource

Signature

methodAddNgrokbuilder
Configures a container resource for grok which is pre-configured to connect to the resource that this method is used on.
AddNgrok(
name string,
options ...*AddNgrokOptions,
) NgrokResource
namestringThe name of the resource.
options...*AddNgrokOptionsOptional settings, described under Options.

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

ConfigurationFolder*stringThe folder where temporary ngrok configuration files will be stored; defaults to .ngrok
EndpointPort*float64The port of the endpoint for this resource, defaults to a randomly assigned port.
EndpointName*stringThe name of the endpoint for this resource, defaults to http.
ConfigurationVersion*float64The output version of the ngrok configuration file.
NgrokResource

A reference to the IResourceBuilder.

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

Applies to

This method applies to the following types:

typeDistributedApplicationBuilder