# NgrokResource

- Module: [CommunityToolkit.Aspire.Hosting.Ngrok](/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok.md)
- Version: `13.4.0`
- Kind: `handle`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire)

## Definition

```typescript
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

- [withAuthToken](/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/ngrokresource/withauthtoken.md) -- `method` -- Adds a ngrok auth token to a ngrok resource.
    ```typescript
  withAuthToken(ngrokAuthToken: ParameterResource): NgrokResource
  ```
- [withAuthTokenValue](/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/ngrokresource/withauthtokenvalue.md) -- `method` -- Adds a ngrok auth token to a ngrok resource.
    ```typescript
  withAuthTokenValue(ngrokAuthToken: string): NgrokResource
  ```
- [withTunnelEndpoint](/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/ngrokresource/withtunnelendpoint.md) -- `method` -- Configures a resource with endpoints as a ngrok tunnel endpoint.
    ```typescript
  withTunnelEndpoint(resource: IResourceWithEndpoints, endpointName: string, ngrokUrl?: string, labels?: Dict<string,string>): NgrokResource
  ```