@microsoft/dev-tunnels-contracts 1.0.7316-gf98d631190

package/tunnelEndpoint.d.ts

@@ -0,0 +1,73 @@
+import { TunnelConnectionMode } from './tunnelConnectionMode';
+/**
+ * Base class for tunnel connection parameters.
+ *
+ * A tunnel endpoint specifies how and where hosts and clients can connect to a tunnel.
+ * There is a subclass for each connection mode, each having different connection
+ * parameters. A tunnel may have multiple endpoints for one host (or multiple hosts), and
+ * clients can select their preferred endpoint(s) from those depending on network
+ * environment or client capabilities.
+ */
+export interface TunnelEndpoint {
+    /**
+     * Gets or sets the connection mode of the endpoint.
+     *
+     * This property is required when creating or updating an endpoint.  The subclass type
+     * is also an indication of the connection mode, but this property is necessary to
+     * determine the subclass type when deserializing.
+     */
+    connectionMode: TunnelConnectionMode;
+    /**
+     * Gets or sets the ID of the host that is listening on this endpoint.
+     *
+     * This property is required when creating or updating an endpoint.  If the host
+     * supports multiple connection modes, the host's ID is the same for all the endpoints
+     * it supports. However different hosts may simultaneously accept connections at
+     * different endpoints for the same tunnel, if enabled in tunnel options.
+     */
+    hostId: string;
+    /**
+     * Gets or sets an array of public keys, which can be used by clients to authenticate
+     * the host.
+     */
+    hostPublicKeys?: string[];
+    /**
+     * Gets or sets a string used to format URIs where a web client can connect to ports
+     * of the tunnel. The string includes a {@link TunnelEndpoint.portToken} that must be
+     * replaced with the actual port number.
+     */
+    portUriFormat?: string;
+    /**
+     * Gets or sets the URI where a web client can connect to the default port of the
+     * tunnel.
+     */
+    tunnelUri?: string;
+    /**
+     * Gets or sets a string used to format ssh command where ssh client can connect to
+     * shared ssh port of the tunnel. The string includes a {@link
+     * TunnelEndpoint.portToken} that must be replaced with the actual port number.
+     */
+    portSshCommandFormat?: string;
+    /**
+     * Gets or sets the Ssh command where the Ssh client can connect to the default ssh
+     * port of the tunnel.
+     */
+    tunnelSshCommand?: string;
+    /**
+     * Gets or sets the Ssh gateway public key which should be added to the
+     * authorized_keys file so that tunnel service can connect to the shared ssh server.
+     */
+    sshGatewayPublicKey?: string;
+}
+/**
+ * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
+ * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
+ */
+export declare const portToken = "{port}";
+import { getPortUri, getPortSshCommand } from './tunnelEndpointStatics';
+export declare const TunnelEndpoint: {
+    portToken: string;
+    getPortUri: typeof getPortUri;
+    getPortSshCommand: typeof getPortSshCommand;
+};
+//# sourceMappingURL=tunnelEndpoint.d.ts.map

package/tunnelEndpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelEndpoint.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelEndpoint.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;OAMG;IACH,cAAc,EAAE,oBAAoB,CAAC;IAErC;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,WAAW,CAAC;AAIlC,OAAO,EACH,UAAU,EACV,iBAAiB,EACpB,MAAM,yBAAyB,CAAC;AAEjC,eAAO,MAAM,cAAc;;;;CAI1B,CAAC"}

package/tunnelEndpoint.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelEndpoint.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelEndpoint = exports.portToken = void 0;
+/**
+ * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
+ * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
+ */
+exports.portToken = '{port}';
+// Import static members from a non-generated file,
+// and re-export them as an object with the same name as the interface.
+const tunnelEndpointStatics_1 = require("./tunnelEndpointStatics");
+exports.TunnelEndpoint = {
+    portToken: exports.portToken,
+    getPortUri: tunnelEndpointStatics_1.getPortUri,
+    getPortSshCommand: tunnelEndpointStatics_1.getPortSshCommand,
+};
+//# sourceMappingURL=tunnelEndpoint.js.map

package/tunnelEndpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelEndpoint.js","sourceRoot":"","sources":["../../../src/contracts/tunnelEndpoint.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,6DAA6D;AAC7D,oBAAoB;;;AAwEpB;;;GAGG;AACU,QAAA,SAAS,GAAG,QAAQ,CAAC;AAElC,mDAAmD;AACnD,uEAAuE;AACvE,mEAGiC;AAEpB,QAAA,cAAc,GAAG;IAC1B,SAAS,EAAT,iBAAS;IACT,UAAU,EAAV,kCAAU;IACV,iBAAiB,EAAjB,yCAAiB;CACpB,CAAC"}

package/tunnelEndpointStatics.d.ts

@@ -0,0 +1,20 @@
+import { TunnelEndpoint as ITunnelEndpoint } from './tunnelEndpoint';
+/**
+ * Gets a URI where a web client can connect to a tunnel port.
+ *
+ * Requests to the URI may result in HTTP 307 redirections, so the client may need to
+ * follow the redirection in order to connect to the port.
+ *
+ * If the port is not currently shared via the tunnel, or if a host is not currently
+ * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
+ * response.
+ *
+ * @param endpoint The tunnel endpoint containing connection information.
+ * @param portNumber The port number to connect to; the port is assumed to be
+ * separately shared by a tunnel host.
+ * @returns URI for the requested port, or `undefined` if the endpoint does not support
+ * web client connections.
+ */
+export declare function getPortUri(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
+export declare function getPortSshCommand(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
+//# sourceMappingURL=tunnelEndpointStatics.d.ts.map

package/tunnelEndpointStatics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelEndpointStatics.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelEndpointStatics.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,IAAI,eAAe,EAAa,MAAM,kBAAkB,CAAC;AAEhF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAc7F;AAED,wBAAgB,iBAAiB,CAC7B,QAAQ,EAAE,eAAe,EACzB,UAAU,CAAC,EAAE,MAAM,GACpB,MAAM,GAAG,SAAS,CAcpB"}

package/tunnelEndpointStatics.js

@@ -0,0 +1,49 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPortSshCommand = exports.getPortUri = void 0;
+const tunnelEndpoint_1 = require("./tunnelEndpoint");
+/**
+ * Gets a URI where a web client can connect to a tunnel port.
+ *
+ * Requests to the URI may result in HTTP 307 redirections, so the client may need to
+ * follow the redirection in order to connect to the port.
+ *
+ * If the port is not currently shared via the tunnel, or if a host is not currently
+ * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
+ * response.
+ *
+ * @param endpoint The tunnel endpoint containing connection information.
+ * @param portNumber The port number to connect to; the port is assumed to be
+ * separately shared by a tunnel host.
+ * @returns URI for the requested port, or `undefined` if the endpoint does not support
+ * web client connections.
+ */
+function getPortUri(endpoint, portNumber) {
+    if (!endpoint) {
+        throw new TypeError('A tunnel endpoint is required.');
+    }
+    if (typeof portNumber !== 'number' && !endpoint.tunnelUri) {
+        return endpoint.tunnelUri;
+    }
+    if (typeof portNumber !== 'number' || !endpoint.portUriFormat) {
+        return undefined;
+    }
+    return endpoint.portUriFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
+}
+exports.getPortUri = getPortUri;
+function getPortSshCommand(endpoint, portNumber) {
+    if (!endpoint) {
+        throw new TypeError('A tunnel endpoint is required.');
+    }
+    if (typeof portNumber !== 'number' && !endpoint.tunnelSshCommand) {
+        return endpoint.tunnelSshCommand;
+    }
+    if (typeof portNumber !== 'number' || !endpoint.portSshCommandFormat) {
+        return undefined;
+    }
+    return endpoint.portSshCommandFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
+}
+exports.getPortSshCommand = getPortSshCommand;
+//# sourceMappingURL=tunnelEndpointStatics.js.map

package/tunnelEndpointStatics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelEndpointStatics.js","sourceRoot":"","sources":["../../../src/contracts/tunnelEndpointStatics.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,qDAAgF;AAEhF;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,UAAU,CAAC,QAAyB,EAAE,UAAmB;IACrE,IAAI,CAAC,QAAQ,EAAE;QACX,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;KACzD;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;QACvD,OAAO,QAAQ,CAAC,SAAS,CAAC;KAC7B;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;QAC3D,OAAO,SAAS,CAAC;KACpB;IAED,OAAO,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,0BAAS,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC5E,CAAC;AAdD,gCAcC;AAED,SAAgB,iBAAiB,CAC7B,QAAyB,EACzB,UAAmB;IAEnB,IAAI,CAAC,QAAQ,EAAE;QACX,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;KACzD;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE;QAC9D,OAAO,QAAQ,CAAC,gBAAgB,CAAC;KACpC;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;QAClE,OAAO,SAAS,CAAC;KACpB;IAED,OAAO,QAAQ,CAAC,oBAAoB,CAAC,OAAO,CAAC,0BAAS,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;AACnF,CAAC;AAjBD,8CAiBC"}

package/tunnelHeaderNames.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Header names for http requests that Tunnel Service can handle
+ */
+export declare enum TunnelHeaderNames {
+    /**
+     * Additional authorization header that can be passed to tunnel web forwarding to
+     * authenticate and authorize the client. The format of the value is the same as
+     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
+     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
+     */
+    XTunnelAuthorization = "X-Tunnel-Authorization",
+    /**
+     * Request ID header that nginx ingress controller adds to all requests if it's not
+     * there.
+     */
+    XRequestID = "X-Request-ID",
+    /**
+     * Github Ssh public key which can be used to validate if it belongs to tunnel's
+     * owner.
+     */
+    XGithubSshKey = "X-Github-Ssh-Key",
+    /**
+     * Header that will skip the antiphishing page when connection to a tunnel through web
+     * forwarding.
+     */
+    XTunnelSkipPhishing = "X-Tunnel-Skip-Phishing-Page"
+}
+//# sourceMappingURL=tunnelHeaderNames.d.ts.map

package/tunnelHeaderNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelHeaderNames.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelHeaderNames.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,oBAAY,iBAAiB;IACzB;;;;;OAKG;IACH,oBAAoB,2BAA2B;IAE/C;;;OAGG;IACH,UAAU,iBAAiB;IAE3B;;;OAGG;IACH,aAAa,qBAAqB;IAElC;;;OAGG;IACH,mBAAmB,gCAAgC;CACtD"}

package/tunnelHeaderNames.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelHeaderNames.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelHeaderNames = void 0;
+/**
+ * Header names for http requests that Tunnel Service can handle
+ */
+var TunnelHeaderNames;
+(function (TunnelHeaderNames) {
+    /**
+     * Additional authorization header that can be passed to tunnel web forwarding to
+     * authenticate and authorize the client. The format of the value is the same as
+     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
+     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
+     */
+    TunnelHeaderNames["XTunnelAuthorization"] = "X-Tunnel-Authorization";
+    /**
+     * Request ID header that nginx ingress controller adds to all requests if it's not
+     * there.
+     */
+    TunnelHeaderNames["XRequestID"] = "X-Request-ID";
+    /**
+     * Github Ssh public key which can be used to validate if it belongs to tunnel's
+     * owner.
+     */
+    TunnelHeaderNames["XGithubSshKey"] = "X-Github-Ssh-Key";
+    /**
+     * Header that will skip the antiphishing page when connection to a tunnel through web
+     * forwarding.
+     */
+    TunnelHeaderNames["XTunnelSkipPhishing"] = "X-Tunnel-Skip-Phishing-Page";
+})(TunnelHeaderNames = exports.TunnelHeaderNames || (exports.TunnelHeaderNames = {}));
+//# sourceMappingURL=tunnelHeaderNames.js.map

package/tunnelHeaderNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelHeaderNames.js","sourceRoot":"","sources":["../../../src/contracts/tunnelHeaderNames.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,gEAAgE;AAChE,oBAAoB;;;AAEpB;;GAEG;AACH,IAAY,iBA0BX;AA1BD,WAAY,iBAAiB;IACzB;;;;;OAKG;IACH,oEAA+C,CAAA;IAE/C;;;OAGG;IACH,gDAA2B,CAAA;IAE3B;;;OAGG;IACH,uDAAkC,CAAA;IAElC;;;OAGG;IACH,wEAAmD,CAAA;AACvD,CAAC,EA1BW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QA0B5B"}

package/tunnelOptions.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Data contract for {@link Tunnel} or {@link TunnelPort} options.
+ */
+export interface TunnelOptions {
+    /**
+     * Gets or sets a value indicating whether web-forwarding of this tunnel can run on
+     * any cluster (region) without redirecting to the home cluster. This is only
+     * applicable if the tunnel has a name and web-forwarding uses it.
+     */
+    isGloballyAvailable?: boolean;
+}
+//# sourceMappingURL=tunnelOptions.d.ts.map

package/tunnelOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelOptions.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelOptions.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACjC"}

package/tunnelOptions.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelOptions.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tunnelOptions.js.map

package/tunnelOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelOptions.js","sourceRoot":"","sources":["../../../src/contracts/tunnelOptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,4DAA4D;AAC5D,oBAAoB"}

package/tunnelPort.d.ts

@@ -0,0 +1,71 @@
+import { TunnelAccessControl } from './tunnelAccessControl';
+import { TunnelOptions } from './tunnelOptions';
+import { TunnelPortStatus } from './tunnelPortStatus';
+/**
+ * Data contract for tunnel port objects managed through the tunnel service REST API.
+ */
+export interface TunnelPort {
+    /**
+     * Gets or sets the ID of the cluster the tunnel was created in.
+     */
+    clusterId?: string;
+    /**
+     * Gets or sets the generated ID of the tunnel, unique within the cluster.
+     */
+    tunnelId?: string;
+    /**
+     * Gets or sets the IP port number of the tunnel port.
+     */
+    portNumber: number;
+    /**
+     * Gets or sets the optional short name of the port.
+     *
+     * The name must be unique among named ports of the same tunnel.
+     */
+    name?: string;
+    /**
+     * Gets or sets the optional description of the port.
+     */
+    description?: string;
+    /**
+     * Gets or sets the tags of the port.
+     */
+    tags?: string[];
+    /**
+     * Gets or sets the protocol of the tunnel port.
+     *
+     * Should be one of the string constants from {@link TunnelProtocol}.
+     */
+    protocol?: string;
+    /**
+     * Gets or sets a dictionary mapping from scopes to tunnel access tokens.
+     *
+     * Unlike the tokens in {@link Tunnel.accessTokens}, these tokens are restricted to
+     * the individual port.
+     */
+    accessTokens?: {
+        [scope: string]: string;
+    };
+    /**
+     * Gets or sets access control settings for the tunnel port.
+     *
+     * See {@link TunnelAccessControl} documentation for details about the access control
+     * model.
+     */
+    accessControl?: TunnelAccessControl;
+    /**
+     * Gets or sets options for the tunnel port.
+     */
+    options?: TunnelOptions;
+    /**
+     * Gets or sets current connection status of the tunnel port.
+     */
+    status?: TunnelPortStatus;
+    /**
+     * Gets or sets the username for the ssh service user is trying to forward.
+     *
+     * Should be provided if the {@link TunnelProtocol} is Ssh.
+     */
+    sshUser?: string;
+}
+//# sourceMappingURL=tunnelPort.d.ts.map

package/tunnelPort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelPort.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelPort.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE3C;;;;;OAKG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/tunnelPort.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelPort.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tunnelPort.js.map

package/tunnelPort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelPort.js","sourceRoot":"","sources":["../../../src/contracts/tunnelPort.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,yDAAyD;AACzD,oBAAoB"}

package/tunnelPortStatus.d.ts

@@ -0,0 +1,40 @@
+import { RateStatus } from './rateStatus';
+import { ResourceStatus } from './resourceStatus';
+/**
+ * Data contract for {@link TunnelPort} status.
+ */
+export interface TunnelPortStatus {
+    /**
+     * Gets or sets the current value and limit for the number of clients connected to the
+     * port.
+     *
+     * This client connection count does not include non-port-specific connections such as
+     * SDK and SSH clients. See {@link TunnelStatus.clientConnectionCount} for status of
+     * those connections.  This count also does not include HTTP client connections,
+     * unless they are upgraded to websockets. HTTP connections are counted per-request
+     * rather than per-connection: see {@link TunnelPortStatus.httpRequestRate}.
+     */
+    clientConnectionCount?: number | ResourceStatus;
+    /**
+     * Gets or sets the UTC date time when a client was last connected to the port, or
+     * null if a client has never connected.
+     */
+    lastClientConnectionTime?: Date;
+    /**
+     * Gets or sets the current value and limit for the rate of client connections to the
+     * tunnel port.
+     *
+     * This client connection rate does not count non-port-specific connections such as
+     * SDK and SSH clients. See {@link TunnelStatus.clientConnectionRate} for those
+     * connection types.  This also does not include HTTP connections, unless they are
+     * upgraded to websockets. HTTP connections are counted per-request rather than
+     * per-connection: see {@link TunnelPortStatus.httpRequestRate}.
+     */
+    clientConnectionRate?: RateStatus;
+    /**
+     * Gets or sets the current value and limit for the rate of HTTP requests to the
+     * tunnel port.
+     */
+    httpRequestRate?: RateStatus;
+}
+//# sourceMappingURL=tunnelPortStatus.d.ts.map

package/tunnelPortStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelPortStatus.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelPortStatus.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IAEhD;;;OAGG;IACH,wBAAwB,CAAC,EAAE,IAAI,CAAC;IAEhC;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,UAAU,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;CAChC"}

package/tunnelPortStatus.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelPortStatus.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tunnelPortStatus.js.map

package/tunnelPortStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelPortStatus.js","sourceRoot":"","sources":["../../../src/contracts/tunnelPortStatus.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,+DAA+D;AAC/D,oBAAoB"}

package/tunnelProtocol.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Defines possible values for the protocol of a {@link TunnelPort}.
+ */
+export declare enum TunnelProtocol {
+    /**
+     * The protocol is automatically detected. (TODO: Define detection semantics.)
+     */
+    Auto = "auto",
+    /**
+     * Unknown TCP protocol.
+     */
+    Tcp = "tcp",
+    /**
+     * Unknown UDP protocol.
+     */
+    Udp = "udp",
+    /**
+     * SSH protocol.
+     */
+    Ssh = "ssh",
+    /**
+     * Remote desktop protocol.
+     */
+    Rdp = "rdp",
+    /**
+     * HTTP protocol.
+     */
+    Http = "http",
+    /**
+     * HTTPS protocol.
+     */
+    Https = "https"
+}
+//# sourceMappingURL=tunnelProtocol.d.ts.map

package/tunnelProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelProtocol.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelProtocol.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,oBAAY,cAAc;IACtB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,GAAG,QAAQ;IAEX;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,KAAK,UAAU;CAClB"}

package/tunnelProtocol.js

@@ -0,0 +1,42 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelProtocol.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelProtocol = void 0;
+/**
+ * Defines possible values for the protocol of a {@link TunnelPort}.
+ */
+var TunnelProtocol;
+(function (TunnelProtocol) {
+    /**
+     * The protocol is automatically detected. (TODO: Define detection semantics.)
+     */
+    TunnelProtocol["Auto"] = "auto";
+    /**
+     * Unknown TCP protocol.
+     */
+    TunnelProtocol["Tcp"] = "tcp";
+    /**
+     * Unknown UDP protocol.
+     */
+    TunnelProtocol["Udp"] = "udp";
+    /**
+     * SSH protocol.
+     */
+    TunnelProtocol["Ssh"] = "ssh";
+    /**
+     * Remote desktop protocol.
+     */
+    TunnelProtocol["Rdp"] = "rdp";
+    /**
+     * HTTP protocol.
+     */
+    TunnelProtocol["Http"] = "http";
+    /**
+     * HTTPS protocol.
+     */
+    TunnelProtocol["Https"] = "https";
+})(TunnelProtocol = exports.TunnelProtocol || (exports.TunnelProtocol = {}));
+//# sourceMappingURL=tunnelProtocol.js.map

package/tunnelProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelProtocol.js","sourceRoot":"","sources":["../../../src/contracts/tunnelProtocol.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,6DAA6D;AAC7D,oBAAoB;;;AAEpB;;GAEG;AACH,IAAY,cAmCX;AAnCD,WAAY,cAAc;IACtB;;OAEG;IACH,+BAAa,CAAA;IAEb;;OAEG;IACH,6BAAW,CAAA;IAEX;;OAEG;IACH,6BAAW,CAAA;IAEX;;OAEG;IACH,6BAAW,CAAA;IAEX;;OAEG;IACH,6BAAW,CAAA;IAEX;;OAEG;IACH,+BAAa,CAAA;IAEb;;OAEG;IACH,iCAAe,CAAA;AACnB,CAAC,EAnCW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAmCzB"}

package/tunnelRelayTunnelEndpoint.d.ts

@@ -0,0 +1,15 @@
+import { TunnelEndpoint } from './tunnelEndpoint';
+/**
+ * Parameters for connecting to a tunnel via the tunnel service's built-in relay function.
+ */
+export interface TunnelRelayTunnelEndpoint extends TunnelEndpoint {
+    /**
+     * Gets or sets the host URI.
+     */
+    hostRelayUri?: string;
+    /**
+     * Gets or sets the client URI.
+     */
+    clientRelayUri?: string;
+}
+//# sourceMappingURL=tunnelRelayTunnelEndpoint.d.ts.map

package/tunnelRelayTunnelEndpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelRelayTunnelEndpoint.d.ts","sourceRoot":"","sources":["../../../src/contracts/tunnelRelayTunnelEndpoint.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC7D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/tunnelRelayTunnelEndpoint.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelRelayTunnelEndpoint.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tunnelRelayTunnelEndpoint.js.map

package/tunnelRelayTunnelEndpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnelRelayTunnelEndpoint.js","sourceRoot":"","sources":["../../../src/contracts/tunnelRelayTunnelEndpoint.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,wEAAwE;AACxE,oBAAoB"}

package/tunnelServiceProperties.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Provides environment-dependent properties about the service.
+ */
+export interface TunnelServiceProperties {
+    /**
+     * Gets the base URI of the service.
+     */
+    serviceUri: string;
+    /**
+     * Gets the public AAD AppId for the service.
+     *
+     * Clients specify this AppId as the audience property when authenticating to the
+     * service.
+     */
+    serviceAppId: string;
+    /**
+     * Gets the internal AAD AppId for the service.
+     *
+     * Other internal services specify this AppId as the audience property when
+     * authenticating to the tunnel service. Production services must be in the AME tenant
+     * to use this appid.
+     */
+    serviceInternalAppId: string;
+    /**
+     * Gets the client ID for the service's GitHub app.
+     *
+     * Clients apps that authenticate tunnel users with GitHub specify this as the client
+     * ID when requesting a user token.
+     */
+    gitHubAppClientId: string;
+}
+/**
+ * Global DNS name of the production tunnel service.
+ */
+export declare const prodDnsName = "global.rel.tunnels.api.visualstudio.com";
+/**
+ * Global DNS name of the pre-production tunnel service.
+ */
+export declare const ppeDnsName = "global.rel.tunnels.ppe.api.visualstudio.com";
+/**
+ * Global DNS name of the development tunnel service.
+ */
+export declare const devDnsName = "global.ci.tunnels.dev.api.visualstudio.com";
+/**
+ * First-party app ID: `Visual Studio Tunnel Service`
+ *
+ * Used for authenticating AAD/MSA users, and service principals outside the AME tenant,
+ * in the PROD service environment.
+ */
+export declare const prodFirstPartyAppId = "46da2f7e-b5ef-422a-88d4-2a7f9de6a0b2";
+/**
+ * First-party app ID: `Visual Studio Tunnel Service - Test`
+ *
+ * Used for authenticating AAD/MSA users, and service principals outside the AME tenant,
+ * in the PPE and DEV service environments.
+ */
+export declare const nonProdFirstPartyAppId = "54c45752-bacd-424a-b928-652f3eca2b18";
+/**
+ * Third-party app ID: `tunnels-prod-app-sp`
+ *
+ * Used for authenticating internal AAD service principals in the AME tenant, in the PROD
+ * service environment.
+ */
+export declare const prodThirdPartyAppId = "ce65d243-a913-4cae-a7dd-cb52e9f77647";
+/**
+ * Third-party app ID: `tunnels-ppe-app-sp`
+ *
+ * Used for authenticating internal AAD service principals in the AME tenant, in the PPE
+ * service environment.
+ */
+export declare const ppeThirdPartyAppId = "544167a6-f431-4518-aac6-2fd50071928e";
+/**
+ * Third-party app ID: `tunnels-dev-app-sp`
+ *
+ * Used for authenticating internal AAD service principals in the corp tenant (not AME!),
+ * in the DEV service environment.
+ */
+export declare const devThirdPartyAppId = "a118c979-0249-44bb-8f95-eb0457127aeb";
+/**
+ * GitHub App Client ID for 'Visual Studio Tunnel Service'
+ *
+ * Used by client apps that authenticate tunnel users with GitHub, in the PROD service
+ * environment.
+ */
+export declare const prodGitHubAppClientId = "Iv1.e7b89e013f801f03";
+/**
+ * GitHub App Client ID for 'Visual Studio Tunnel Service - Test'
+ *
+ * Used by client apps that authenticate tunnel users with GitHub, in the PPE and DEV
+ * service environments.
+ */
+export declare const nonProdGitHubAppClientId = "Iv1.b231c327f1eaa229";
+import { environment } from './tunnelServicePropertiesStatics';
+export declare const TunnelServiceProperties: {
+    production: TunnelServiceProperties;
+    staging: TunnelServiceProperties;
+    development: TunnelServiceProperties;
+    environment: typeof environment;
+};
+//# sourceMappingURL=tunnelServiceProperties.d.ts.map