@microsoft/dev-tunnels-contracts 1.0.8 → 1.0.7302

package/tunnelHeaderNames.d.ts

@@ -1,28 +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"
-}
+/**
+ * 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.js

@@ -1,36 +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 = {}));
+"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/tunnelOptions.d.ts

@@ -1,12 +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;
-}
+/**
+ * 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.js

@@ -1,7 +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 });
+"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/tunnelPort.d.ts

@@ -1,71 +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;
-}
+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.js

@@ -1,7 +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 });
+"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/tunnelPortStatus.d.ts

@@ -1,40 +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;
-}
+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.js

@@ -1,7 +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 });
+"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/tunnelProtocol.d.ts

@@ -1,34 +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"
-}
+/**
+ * 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.js

@@ -1,42 +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 = {}));
+"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/tunnelRelayTunnelEndpoint.d.ts

@@ -1,15 +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;
-}
+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.js

@@ -1,7 +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 });
+"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