@microsoft/dev-tunnels-contracts 1.3.6 → 1.3.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/README.md +2 -2
  2. package/clusterDetails.d.ts +19 -19
  3. package/clusterDetails.js +6 -6
  4. package/errorCodes.d.ts +17 -17
  5. package/errorCodes.js +25 -25
  6. package/errorDetail.d.ts +27 -27
  7. package/errorDetail.js +6 -6
  8. package/index.d.ts +24 -24
  9. package/index.js +29 -29
  10. package/innerErrorDetail.d.ts +15 -15
  11. package/innerErrorDetail.js +6 -6
  12. package/localNetworkTunnelEndpoint.d.ts +20 -20
  13. package/localNetworkTunnelEndpoint.js +6 -6
  14. package/namedRateStatus.d.ts +10 -10
  15. package/namedRateStatus.js +6 -6
  16. package/package.json +1 -1
  17. package/problemDetails.d.ts +24 -24
  18. package/problemDetails.js +6 -6
  19. package/rateStatus.d.ts +19 -19
  20. package/rateStatus.js +6 -6
  21. package/resourceStatus.d.ts +22 -22
  22. package/resourceStatus.js +6 -6
  23. package/serviceVersionDetails.d.ts +26 -26
  24. package/serviceVersionDetails.js +6 -6
  25. package/tsbuildinfo.json +1 -1
  26. package/tunnel.d.ts +87 -87
  27. package/tunnel.js +6 -6
  28. package/tunnelAccessControl.d.ts +27 -27
  29. package/tunnelAccessControl.js +13 -13
  30. package/tunnelAccessControlEntry.d.ts +116 -116
  31. package/tunnelAccessControlEntry.js +40 -40
  32. package/tunnelAccessControlEntryType.d.ts +45 -45
  33. package/tunnelAccessControlEntryType.js +53 -53
  34. package/tunnelAccessControlStatics.d.ts +10 -10
  35. package/tunnelAccessControlStatics.js +46 -46
  36. package/tunnelAccessScopes.d.ts +38 -38
  37. package/tunnelAccessScopes.js +46 -46
  38. package/tunnelAccessSubject.d.ts +39 -39
  39. package/tunnelAccessSubject.js +6 -6
  40. package/tunnelAuthenticationSchemes.d.ts +21 -21
  41. package/tunnelAuthenticationSchemes.js +29 -29
  42. package/tunnelConnectionMode.d.ts +19 -19
  43. package/tunnelConnectionMode.js +27 -27
  44. package/tunnelConstraints.d.ts +268 -253
  45. package/tunnelConstraints.d.ts.map +1 -1
  46. package/tunnelConstraints.js +276 -261
  47. package/tunnelConstraints.js.map +1 -1
  48. package/tunnelEndpoint.d.ts +76 -76
  49. package/tunnelEndpoint.js +20 -20
  50. package/tunnelEndpointStatics.d.ts +19 -19
  51. package/tunnelEndpointStatics.js +48 -48
  52. package/tunnelEvent.d.ts +48 -48
  53. package/tunnelEvent.js +24 -24
  54. package/tunnelHeaderNames.d.ts +27 -27
  55. package/tunnelHeaderNames.js +35 -35
  56. package/tunnelListByRegion.d.ts +23 -23
  57. package/tunnelListByRegion.js +6 -6
  58. package/tunnelListByRegionResponse.d.ts +14 -14
  59. package/tunnelListByRegionResponse.js +6 -6
  60. package/tunnelOptions.d.ts +99 -78
  61. package/tunnelOptions.d.ts.map +1 -1
  62. package/tunnelOptions.js +6 -6
  63. package/tunnelPort.d.ts +93 -93
  64. package/tunnelPort.js +6 -6
  65. package/tunnelPortListResponse.d.ts +14 -14
  66. package/tunnelPortListResponse.js +6 -6
  67. package/tunnelPortStatus.d.ts +39 -39
  68. package/tunnelPortStatus.js +6 -6
  69. package/tunnelProgress.d.ts +45 -45
  70. package/tunnelProgress.js +53 -53
  71. package/tunnelProtocol.d.ts +33 -33
  72. package/tunnelProtocol.js +41 -41
  73. package/tunnelRelayTunnelEndpoint.d.ts +14 -14
  74. package/tunnelRelayTunnelEndpoint.js +6 -6
  75. package/tunnelReportProgressEventArgs.d.ts +15 -15
  76. package/tunnelReportProgressEventArgs.js +6 -6
  77. package/tunnelServiceProperties.d.ts +107 -106
  78. package/tunnelServiceProperties.d.ts.map +1 -1
  79. package/tunnelServiceProperties.js +85 -84
  80. package/tunnelServiceProperties.js.map +1 -1
  81. package/tunnelServicePropertiesStatics.d.ts +17 -17
  82. package/tunnelServicePropertiesStatics.js +55 -55
  83. package/tunnelStatus.d.ts +100 -100
  84. package/tunnelStatus.js +6 -6
@@ -1,24 +1,24 @@
1
- import { ErrorDetail } from './errorDetail';
2
- import { Tunnel } from './tunnel';
3
- /**
4
- * Tunnel list by region.
5
- */
6
- export interface TunnelListByRegion {
7
- /**
8
- * Azure region name.
9
- */
10
- regionName?: string;
11
- /**
12
- * Cluster id in the region.
13
- */
14
- clusterId?: string;
15
- /**
16
- * List of tunnels.
17
- */
18
- value?: Tunnel[];
19
- /**
20
- * Error detail if getting list of tunnels in the region failed.
21
- */
22
- error?: ErrorDetail;
23
- }
1
+ import { ErrorDetail } from './errorDetail';
2
+ import { Tunnel } from './tunnel';
3
+ /**
4
+ * Tunnel list by region.
5
+ */
6
+ export interface TunnelListByRegion {
7
+ /**
8
+ * Azure region name.
9
+ */
10
+ regionName?: string;
11
+ /**
12
+ * Cluster id in the region.
13
+ */
14
+ clusterId?: string;
15
+ /**
16
+ * List of tunnels.
17
+ */
18
+ value?: Tunnel[];
19
+ /**
20
+ * Error detail if getting list of tunnels in the region failed.
21
+ */
22
+ error?: ErrorDetail;
23
+ }
24
24
  //# sourceMappingURL=tunnelListByRegion.d.ts.map
@@ -1,7 +1,7 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- // Generated from ../../../cs/src/Contracts/TunnelListByRegion.cs
5
- /* eslint-disable */
6
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ // Generated from ../../../cs/src/Contracts/TunnelListByRegion.cs
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  //# sourceMappingURL=tunnelListByRegion.js.map
@@ -1,15 +1,15 @@
1
- import { TunnelListByRegion } from './tunnelListByRegion';
2
- /**
3
- * Data contract for response of a list tunnel by region call.
4
- */
5
- export interface TunnelListByRegionResponse {
6
- /**
7
- * List of tunnels
8
- */
9
- value?: TunnelListByRegion[];
10
- /**
11
- * Link to get next page of results.
12
- */
13
- nextLink?: string;
14
- }
1
+ import { TunnelListByRegion } from './tunnelListByRegion';
2
+ /**
3
+ * Data contract for response of a list tunnel by region call.
4
+ */
5
+ export interface TunnelListByRegionResponse {
6
+ /**
7
+ * List of tunnels
8
+ */
9
+ value?: TunnelListByRegion[];
10
+ /**
11
+ * Link to get next page of results.
12
+ */
13
+ nextLink?: string;
14
+ }
15
15
  //# sourceMappingURL=tunnelListByRegionResponse.d.ts.map
@@ -1,7 +1,7 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- // Generated from ../../../cs/src/Contracts/TunnelListByRegionResponse.cs
5
- /* eslint-disable */
6
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ // Generated from ../../../cs/src/Contracts/TunnelListByRegionResponse.cs
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  //# sourceMappingURL=tunnelListByRegionResponse.js.map
@@ -1,79 +1,100 @@
1
- /**
2
- * Data contract for {@link Tunnel} or {@link TunnelPort} options.
3
- */
4
- export interface TunnelOptions {
5
- /**
6
- * Gets or sets a value indicating whether web-forwarding of this tunnel can run on
7
- * any cluster (region) without redirecting to the home cluster. This is only
8
- * applicable if the tunnel has a name and web-forwarding uses it.
9
- */
10
- isGloballyAvailable?: boolean;
11
- /**
12
- * Gets or sets a value for `Host` header rewriting to use in web-forwarding of this
13
- * tunnel or port. By default, with this property null or empty, web-forwarding uses
14
- * "localhost" to rewrite the header. Web-fowarding will use this property instead if
15
- * it is not null or empty. Port-level option, if set, takes precedence over this
16
- * option on the tunnel level. The option is ignored if IsHostHeaderUnchanged is true.
17
- */
18
- hostHeader?: string;
19
- /**
20
- * Gets or sets a value indicating whether `Host` header is rewritten or the header
21
- * value stays intact. By default, if false, web-forwarding rewrites the host header
22
- * with the value from HostHeader property or "localhost". If true, the host header
23
- * will be whatever the tunnel's web-forwarding host is, e.g.
24
- * tunnel-name-8080.devtunnels.ms. Port-level option, if set, takes precedence over
25
- * this option on the tunnel level.
26
- */
27
- isHostHeaderUnchanged?: boolean;
28
- /**
29
- * Gets or sets a value for `Origin` header rewriting to use in web-forwarding of this
30
- * tunnel or port. By default, with this property null or empty, web-forwarding uses
31
- * "http(s)://localhost" to rewrite the header. Web-fowarding will use this property
32
- * instead if it is not null or empty. Port-level option, if set, takes precedence
33
- * over this option on the tunnel level. The option is ignored if
34
- * IsOriginHeaderUnchanged is true.
35
- */
36
- originHeader?: string;
37
- /**
38
- * Gets or sets a value indicating whether `Origin` header is rewritten or the header
39
- * value stays intact. By default, if false, web-forwarding rewrites the origin header
40
- * with the value from OriginHeader property or "http(s)://localhost". If true, the
41
- * Origin header will be whatever the tunnel's web-forwarding Origin is, e.g.
42
- * https://tunnel-name-8080.devtunnels.ms. Port-level option, if set, takes precedence
43
- * over this option on the tunnel level.
44
- */
45
- isOriginHeaderUnchanged?: boolean;
46
- /**
47
- * Gets or sets if inspection is enabled for the tunnel.
48
- */
49
- isInspectionEnabled?: boolean;
50
- /**
51
- * Gets or sets a value indicating whether web requests to a tunnel can use the tunnel
52
- * web authentication cookie if they come from a different site. Specifically, this
53
- * controls whether the tunnel web-forwarding authentication cookie is marked as
54
- * SameSite=None. The default is false, which means the cookie is marked as
55
- * SameSite=Lax. This only applies to tunnels that require authentication.
56
- */
57
- isCrossSiteAuthenticationEnabled?: boolean;
58
- /**
59
- * Gets or sets a value indicating whether the tunnel web-forwarding authentication
60
- * cookie is set as Partitioned (CHIPS). The default is false. This only applies to
61
- * tunnels that require authentication.
62
- *
63
- * A partitioned cookie always also has SameSite=None for compatbility with browsers
64
- * that do not support partitioning.
65
- */
66
- isPartitionedSiteAuthenticationEnabled?: boolean;
67
- /**
68
- * Gets or sets the timeout for HTTP requests to the tunnel or port.
69
- *
70
- * The default timeout is 100 seconds. Set this to 0 to disable the timeout. The
71
- * timeout will reset when response headers are received or after successfully reading
72
- * or writing any request, response, or streaming data like gRPC or WebSockets. TCP
73
- * keep-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket
74
- * pings will. When a request times out, the tunnel relay aborts the request and
75
- * returns 504 Gateway Timeout.
76
- */
77
- requestTimeoutSeconds?: number;
78
- }
1
+ /**
2
+ * Data contract for {@link Tunnel} or {@link TunnelPort} options.
3
+ */
4
+ export interface TunnelOptions {
5
+ /**
6
+ * Gets or sets a value indicating whether web-forwarding of this tunnel can run on
7
+ * any cluster (region) without redirecting to the home cluster. This is only
8
+ * applicable if the tunnel has a name and web-forwarding uses it.
9
+ */
10
+ isGloballyAvailable?: boolean;
11
+ /**
12
+ * Gets or sets a value for `Host` header rewriting to use in web-forwarding of this
13
+ * tunnel or port. By default, with this property null or empty, web-forwarding uses
14
+ * "localhost" to rewrite the header. Web-fowarding will use this property instead if
15
+ * it is not null or empty. Port-level option, if set, takes precedence over this
16
+ * option on the tunnel level. The option is ignored if IsHostHeaderUnchanged is true.
17
+ */
18
+ hostHeader?: string;
19
+ /**
20
+ * Gets or sets a value indicating whether `Host` header is rewritten or the header
21
+ * value stays intact. By default, if false, web-forwarding rewrites the host header
22
+ * with the value from HostHeader property or "localhost". If true, the host header
23
+ * will be whatever the tunnel's web-forwarding host is, e.g.
24
+ * tunnel-name-8080.devtunnels.ms. Port-level option, if set, takes precedence over
25
+ * this option on the tunnel level.
26
+ */
27
+ isHostHeaderUnchanged?: boolean;
28
+ /**
29
+ * Gets or sets a value for `Origin` header rewriting to use in web-forwarding of this
30
+ * tunnel or port. By default, with this property null or empty, web-forwarding uses
31
+ * "http(s)://localhost" to rewrite the header. Web-fowarding will use this property
32
+ * instead if it is not null or empty. Port-level option, if set, takes precedence
33
+ * over this option on the tunnel level. The option is ignored if
34
+ * IsOriginHeaderUnchanged is true.
35
+ */
36
+ originHeader?: string;
37
+ /**
38
+ * Gets or sets a value indicating whether `Origin` header is rewritten or the header
39
+ * value stays intact. By default, if false, web-forwarding rewrites the origin header
40
+ * with the value from OriginHeader property or "http(s)://localhost". If true, the
41
+ * Origin header will be whatever the tunnel's web-forwarding Origin is, e.g.
42
+ * https://tunnel-name-8080.devtunnels.ms. Port-level option, if set, takes precedence
43
+ * over this option on the tunnel level.
44
+ */
45
+ isOriginHeaderUnchanged?: boolean;
46
+ /**
47
+ * Gets or sets if inspection is enabled for the tunnel.
48
+ */
49
+ isInspectionEnabled?: boolean;
50
+ /**
51
+ * Gets or sets a value indicating whether web requests to a tunnel can use the tunnel
52
+ * web authentication cookie if they come from a different site. Specifically, this
53
+ * controls whether the tunnel web-forwarding authentication cookie is marked as
54
+ * SameSite=None. The default is false, which means the cookie is marked as
55
+ * SameSite=Lax. This only applies to tunnels that require authentication.
56
+ */
57
+ isCrossSiteAuthenticationEnabled?: boolean;
58
+ /**
59
+ * Gets or sets a value indicating whether the tunnel web-forwarding authentication
60
+ * cookie is set as Partitioned (CHIPS). The default is false. This only applies to
61
+ * tunnels that require authentication.
62
+ *
63
+ * A partitioned cookie always also has SameSite=None for compatbility with browsers
64
+ * that do not support partitioning.
65
+ */
66
+ isPartitionedSiteAuthenticationEnabled?: boolean;
67
+ /**
68
+ * Gets or sets a value indicating whether web requests to the tunnel or port can be
69
+ * directly authenticated with bearer token authentication by supplying an
70
+ * `Authorization` header with an Entra ID or GitHub token of a user with access to
71
+ * the tunnel. The default is false, which means only the tunnel web authentication
72
+ * cookie or `X-Tunnel-Authorization` header can be used for authenticating web
73
+ * requests to the tunnel.
74
+ *
75
+ * When this option is enabled, AND neither a tunnel web authentication cookie nor an
76
+ * `X-Tunnel-Authorization` header is present in a web request, the tunnel relay will
77
+ * attempt to authenticate the request using the `Authorization` header with Entra ID
78
+ * or GitHub credentials. In that case the `Authorization` header will be stripped
79
+ * from the request before it is forwarded to the host application. Enabling this
80
+ * option may be desirable for API tunnels, where clients are likely to have better
81
+ * support for bearer token authentication using the `Authorization` header. However,
82
+ * interception of that header could block host applications which themselves
83
+ * implement bearer token authentication, which is why this option is disabled by
84
+ * default. This option does not apply to the tunnel management API, which always
85
+ * supports bearer token authentication using the `Authorization` header.
86
+ */
87
+ isBearerTokenAuthenticationEnabled?: boolean;
88
+ /**
89
+ * Gets or sets the timeout for HTTP requests to the tunnel or port.
90
+ *
91
+ * The default timeout is 100 seconds. Set this to 0 to disable the timeout. The
92
+ * timeout will reset when response headers are received or after successfully reading
93
+ * or writing any request, response, or streaming data like gRPC or WebSockets. TCP
94
+ * keep-alives and HTTP/2 protocol pings will not reset the timeout, but WebSocket
95
+ * pings will. When a request times out, the tunnel relay aborts the request and
96
+ * returns 504 Gateway Timeout.
97
+ */
98
+ requestTimeoutSeconds?: number;
99
+ }
79
100
  //# sourceMappingURL=tunnelOptions.d.ts.map
@@ -1 +1 @@
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;IAE9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;;;;;OAOG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;IAEjD;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC"}
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;IAE9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;;;;;OAOG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;IAE7C;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC"}
package/tunnelOptions.js CHANGED
@@ -1,7 +1,7 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- // Generated from ../../../cs/src/Contracts/TunnelOptions.cs
5
- /* eslint-disable */
6
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ // Generated from ../../../cs/src/Contracts/TunnelOptions.cs
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  //# sourceMappingURL=tunnelOptions.js.map
package/tunnelPort.d.ts CHANGED
@@ -1,94 +1,94 @@
1
- import { TunnelAccessControl } from './tunnelAccessControl';
2
- import { TunnelOptions } from './tunnelOptions';
3
- import { TunnelPortStatus } from './tunnelPortStatus';
4
- /**
5
- * Data contract for tunnel port objects managed through the tunnel service REST API.
6
- */
7
- export interface TunnelPort {
8
- /**
9
- * Gets or sets the ID of the cluster the tunnel was created in.
10
- */
11
- clusterId?: string;
12
- /**
13
- * Gets or sets the generated ID of the tunnel, unique within the cluster.
14
- */
15
- tunnelId?: string;
16
- /**
17
- * Gets or sets the IP port number of the tunnel port.
18
- */
19
- portNumber: number;
20
- /**
21
- * Gets or sets the optional short name of the port.
22
- *
23
- * The name must be unique among named ports of the same tunnel.
24
- */
25
- name?: string;
26
- /**
27
- * Gets or sets the optional description of the port.
28
- */
29
- description?: string;
30
- /**
31
- * Gets or sets the labels of the port.
32
- */
33
- labels?: string[];
34
- /**
35
- * Gets or sets the protocol of the tunnel port.
36
- *
37
- * Should be one of the string constants from {@link TunnelProtocol}.
38
- */
39
- protocol?: string;
40
- /**
41
- * Gets or sets a value indicating whether this port is a default port for the tunnel.
42
- *
43
- * A client that connects to a tunnel (by ID or name) without specifying a port number
44
- * will connect to the default port for the tunnel, if a default is configured. Or if
45
- * the tunnel has only one port then the single port is the implicit default.
46
- *
47
- * Selection of a default port for a connection also depends on matching the
48
- * connection to the port {@link TunnelPort.protocol}, so it is possible to configure
49
- * separate defaults for distinct protocols like {@link TunnelProtocol.http} and
50
- * {@link TunnelProtocol.ssh}.
51
- */
52
- isDefault?: boolean;
53
- /**
54
- * Gets or sets a dictionary mapping from scopes to tunnel access tokens.
55
- *
56
- * Unlike the tokens in {@link Tunnel.accessTokens}, these tokens are restricted to
57
- * the individual port.
58
- */
59
- accessTokens?: {
60
- [scope: string]: string;
61
- };
62
- /**
63
- * Gets or sets access control settings for the tunnel port.
64
- *
65
- * See {@link TunnelAccessControl} documentation for details about the access control
66
- * model.
67
- */
68
- accessControl?: TunnelAccessControl;
69
- /**
70
- * Gets or sets options for the tunnel port.
71
- */
72
- options?: TunnelOptions;
73
- /**
74
- * Gets or sets current connection status of the tunnel port.
75
- */
76
- status?: TunnelPortStatus;
77
- /**
78
- * Gets or sets the username for the ssh service user is trying to forward.
79
- *
80
- * Should be provided if the {@link TunnelProtocol} is Ssh.
81
- */
82
- sshUser?: string;
83
- /**
84
- * Gets or sets web forwarding URIs. If set, it's a list of absolute URIs where the
85
- * port can be accessed with web forwarding.
86
- */
87
- portForwardingUris?: string[];
88
- /**
89
- * Gets or sets inspection URI. If set, it's an absolute URIs where the port's traffic
90
- * can be inspected.
91
- */
92
- inspectionUri?: string;
93
- }
1
+ import { TunnelAccessControl } from './tunnelAccessControl';
2
+ import { TunnelOptions } from './tunnelOptions';
3
+ import { TunnelPortStatus } from './tunnelPortStatus';
4
+ /**
5
+ * Data contract for tunnel port objects managed through the tunnel service REST API.
6
+ */
7
+ export interface TunnelPort {
8
+ /**
9
+ * Gets or sets the ID of the cluster the tunnel was created in.
10
+ */
11
+ clusterId?: string;
12
+ /**
13
+ * Gets or sets the generated ID of the tunnel, unique within the cluster.
14
+ */
15
+ tunnelId?: string;
16
+ /**
17
+ * Gets or sets the IP port number of the tunnel port.
18
+ */
19
+ portNumber: number;
20
+ /**
21
+ * Gets or sets the optional short name of the port.
22
+ *
23
+ * The name must be unique among named ports of the same tunnel.
24
+ */
25
+ name?: string;
26
+ /**
27
+ * Gets or sets the optional description of the port.
28
+ */
29
+ description?: string;
30
+ /**
31
+ * Gets or sets the labels of the port.
32
+ */
33
+ labels?: string[];
34
+ /**
35
+ * Gets or sets the protocol of the tunnel port.
36
+ *
37
+ * Should be one of the string constants from {@link TunnelProtocol}.
38
+ */
39
+ protocol?: string;
40
+ /**
41
+ * Gets or sets a value indicating whether this port is a default port for the tunnel.
42
+ *
43
+ * A client that connects to a tunnel (by ID or name) without specifying a port number
44
+ * will connect to the default port for the tunnel, if a default is configured. Or if
45
+ * the tunnel has only one port then the single port is the implicit default.
46
+ *
47
+ * Selection of a default port for a connection also depends on matching the
48
+ * connection to the port {@link TunnelPort.protocol}, so it is possible to configure
49
+ * separate defaults for distinct protocols like {@link TunnelProtocol.http} and
50
+ * {@link TunnelProtocol.ssh}.
51
+ */
52
+ isDefault?: boolean;
53
+ /**
54
+ * Gets or sets a dictionary mapping from scopes to tunnel access tokens.
55
+ *
56
+ * Unlike the tokens in {@link Tunnel.accessTokens}, these tokens are restricted to
57
+ * the individual port.
58
+ */
59
+ accessTokens?: {
60
+ [scope: string]: string;
61
+ };
62
+ /**
63
+ * Gets or sets access control settings for the tunnel port.
64
+ *
65
+ * See {@link TunnelAccessControl} documentation for details about the access control
66
+ * model.
67
+ */
68
+ accessControl?: TunnelAccessControl;
69
+ /**
70
+ * Gets or sets options for the tunnel port.
71
+ */
72
+ options?: TunnelOptions;
73
+ /**
74
+ * Gets or sets current connection status of the tunnel port.
75
+ */
76
+ status?: TunnelPortStatus;
77
+ /**
78
+ * Gets or sets the username for the ssh service user is trying to forward.
79
+ *
80
+ * Should be provided if the {@link TunnelProtocol} is Ssh.
81
+ */
82
+ sshUser?: string;
83
+ /**
84
+ * Gets or sets web forwarding URIs. If set, it's a list of absolute URIs where the
85
+ * port can be accessed with web forwarding.
86
+ */
87
+ portForwardingUris?: string[];
88
+ /**
89
+ * Gets or sets inspection URI. If set, it's an absolute URIs where the port's traffic
90
+ * can be inspected.
91
+ */
92
+ inspectionUri?: string;
93
+ }
94
94
  //# sourceMappingURL=tunnelPort.d.ts.map
package/tunnelPort.js CHANGED
@@ -1,7 +1,7 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- // Generated from ../../../cs/src/Contracts/TunnelPort.cs
5
- /* eslint-disable */
6
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ // Generated from ../../../cs/src/Contracts/TunnelPort.cs
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  //# sourceMappingURL=tunnelPort.js.map
@@ -1,15 +1,15 @@
1
- import { TunnelPort } from './tunnelPort';
2
- /**
3
- * Data contract for response of a list tunnel ports call.
4
- */
5
- export interface TunnelPortListResponse {
6
- /**
7
- * List of tunnels
8
- */
9
- value: TunnelPort[];
10
- /**
11
- * Link to get next page of results
12
- */
13
- nextLink?: string;
14
- }
1
+ import { TunnelPort } from './tunnelPort';
2
+ /**
3
+ * Data contract for response of a list tunnel ports call.
4
+ */
5
+ export interface TunnelPortListResponse {
6
+ /**
7
+ * List of tunnels
8
+ */
9
+ value: TunnelPort[];
10
+ /**
11
+ * Link to get next page of results
12
+ */
13
+ nextLink?: string;
14
+ }
15
15
  //# sourceMappingURL=tunnelPortListResponse.d.ts.map
@@ -1,7 +1,7 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- // Generated from ../../../cs/src/Contracts/TunnelPortListResponse.cs
5
- /* eslint-disable */
6
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ // Generated from ../../../cs/src/Contracts/TunnelPortListResponse.cs
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  //# sourceMappingURL=tunnelPortListResponse.js.map
@@ -1,40 +1,40 @@
1
- import { RateStatus } from './rateStatus';
2
- import { ResourceStatus } from './resourceStatus';
3
- /**
4
- * Data contract for {@link TunnelPort} status.
5
- */
6
- export interface TunnelPortStatus {
7
- /**
8
- * Gets or sets the current value and limit for the number of clients connected to the
9
- * port.
10
- *
11
- * This client connection count does not include non-port-specific connections such as
12
- * SDK and SSH clients. See {@link TunnelStatus.clientConnectionCount} for status of
13
- * those connections. This count also does not include HTTP client connections,
14
- * unless they are upgraded to websockets. HTTP connections are counted per-request
15
- * rather than per-connection: see {@link TunnelPortStatus.httpRequestRate}.
16
- */
17
- clientConnectionCount?: number | ResourceStatus;
18
- /**
19
- * Gets or sets the UTC date time when a client was last connected to the port, or
20
- * null if a client has never connected.
21
- */
22
- lastClientConnectionTime?: Date;
23
- /**
24
- * Gets or sets the current value and limit for the rate of client connections to the
25
- * tunnel port.
26
- *
27
- * This client connection rate does not count non-port-specific connections such as
28
- * SDK and SSH clients. See {@link TunnelStatus.clientConnectionRate} for those
29
- * connection types. This also does not include HTTP connections, unless they are
30
- * upgraded to websockets. HTTP connections are counted per-request rather than
31
- * per-connection: see {@link TunnelPortStatus.httpRequestRate}.
32
- */
33
- clientConnectionRate?: RateStatus;
34
- /**
35
- * Gets or sets the current value and limit for the rate of HTTP requests to the
36
- * tunnel port.
37
- */
38
- httpRequestRate?: RateStatus;
39
- }
1
+ import { RateStatus } from './rateStatus';
2
+ import { ResourceStatus } from './resourceStatus';
3
+ /**
4
+ * Data contract for {@link TunnelPort} status.
5
+ */
6
+ export interface TunnelPortStatus {
7
+ /**
8
+ * Gets or sets the current value and limit for the number of clients connected to the
9
+ * port.
10
+ *
11
+ * This client connection count does not include non-port-specific connections such as
12
+ * SDK and SSH clients. See {@link TunnelStatus.clientConnectionCount} for status of
13
+ * those connections. This count also does not include HTTP client connections,
14
+ * unless they are upgraded to websockets. HTTP connections are counted per-request
15
+ * rather than per-connection: see {@link TunnelPortStatus.httpRequestRate}.
16
+ */
17
+ clientConnectionCount?: number | ResourceStatus;
18
+ /**
19
+ * Gets or sets the UTC date time when a client was last connected to the port, or
20
+ * null if a client has never connected.
21
+ */
22
+ lastClientConnectionTime?: Date;
23
+ /**
24
+ * Gets or sets the current value and limit for the rate of client connections to the
25
+ * tunnel port.
26
+ *
27
+ * This client connection rate does not count non-port-specific connections such as
28
+ * SDK and SSH clients. See {@link TunnelStatus.clientConnectionRate} for those
29
+ * connection types. This also does not include HTTP connections, unless they are
30
+ * upgraded to websockets. HTTP connections are counted per-request rather than
31
+ * per-connection: see {@link TunnelPortStatus.httpRequestRate}.
32
+ */
33
+ clientConnectionRate?: RateStatus;
34
+ /**
35
+ * Gets or sets the current value and limit for the rate of HTTP requests to the
36
+ * tunnel port.
37
+ */
38
+ httpRequestRate?: RateStatus;
39
+ }
40
40
  //# sourceMappingURL=tunnelPortStatus.d.ts.map