NgrokResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Ngrok v13.4.0

interface NgrokResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  withAuthToken(ngrokAuthToken: ParameterResource): NgrokResource;
  withAuthTokenValue(ngrokAuthToken: string): NgrokResource;
  withTunnelEndpoint(
      resource: IResourceWithEndpoints,
      endpointName: string,
      ngrokUrl?: string,
      labels?: Dict<string,string>): NgrokResource;
}

Methods

method withAuthToken builder

Adds a ngrok auth token to a ngrok resource.

withAuthToken(ngrokAuthToken: ParameterResource): NgrokResource

Parameters

ngrokAuthToken ParameterResource

Returns

NgrokResource

method withAuthTokenValue builder

Adds a ngrok auth token to a ngrok resource.

withAuthTokenValue(ngrokAuthToken: string): NgrokResource

Parameters

ngrokAuthToken string

Returns

NgrokResource

method withTunnelEndpoint builder

Configures a resource with endpoints as a ngrok tunnel endpoint.

withTunnelEndpoint(
    resource: IResourceWithEndpoints,
    endpointName: string,
    ngrokUrl?: string,
    labels?: Dict<string,string>): NgrokResource

Parameters

resource IResourceWithEndpoints

endpointName string

ngrokUrl string optional

labels Dict<string,string> optional

Returns

NgrokResource