@microsoft/dev-tunnels-management 1.0.8 → 1.0.7302

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.
@@ -1,69 +1,69 @@
1
- /**
2
- * Options for tunnel service requests.
3
- */
4
- export interface TunnelRequestOptions {
5
- /**
6
- * Gets or sets an access token for the request.
7
- *
8
- * Note this should not be a _user_ access token (such as AAD or GitHub); use the
9
- * callback parameter to the `TunnelManagementHttpClient` constructor to
10
- * supply user access tokens.
11
- */
12
- accessToken?: string;
13
- /**
14
- * Gets or sets additional headers to be included in the request.
15
- */
16
- additionalHeaders?: {
17
- [header: string]: string;
18
- };
19
- /**
20
- * Gets or sets additional query parameters to be included in the request.
21
- */
22
- additionalQueryParameters?: {
23
- [name: string]: string;
24
- };
25
- /**
26
- * Gets or sets a value that indicates whether HTTP redirect responses will be
27
- * automatically followed.
28
- *
29
- * The default is true. If false, a redirect response will cause an error to be thrown,
30
- * with redirect target URI available at `error.response.headers.location`.
31
- *
32
- * The tunnel service often redirects requests to the "home" cluster of the requested
33
- * tunnel, when necessary to fulfill the request.
34
- */
35
- followRedirects?: boolean;
36
- /**
37
- * Gets or sets a flag that requests tunnel ports when retrieving a tunnel object.
38
- */
39
- includePorts?: boolean;
40
- /**
41
- * Gets or sets an optional list of tags to filter the requested tunnels or ports.
42
- *
43
- * Requested tags are compared to the `Tunnel.tags` or `TunnelPort.tags` when calling
44
- * `TunnelManagementClient.listTunnels` or `TunnelManagementClient.listTunnelPorts`
45
- * respectively. By default, an item is included if ANY tag matches; set `requireAllTags`
46
- * to match ALL tags instead.
47
- */
48
- tags?: string[];
49
- requireAllTags?: boolean;
50
- /**
51
- * Gets or sets an optional list of token scopes that are requested when retrieving a
52
- * tunnel or tunnel port object.
53
- *
54
- * Each item in the array must be a single scope from `TunnelAccessScopes` or a space-
55
- * delimited combination of multiple scopes. The service issues an access token for
56
- * each scope or combination and returns the token(s) in the `Tunnel.accessTokens` or
57
- * `TunnelPort.accessTokens` dictionary. If the caller does not have permission to get
58
- * a token for one or more scopes then a token is not returned but the overall request
59
- * does not fail. Token properties including scopes and expiration may be checked using
60
- * `TunnelAccessTokenProperties`.
61
- */
62
- tokenScopes?: string[];
63
- /**
64
- * If true on a create or update request then upon a name conflict, attempt to rename the
65
- * existing tunnel to null and give the name to the tunnel from the request.
66
- */
67
- forceRename?: boolean;
68
- }
1
+ /**
2
+ * Options for tunnel service requests.
3
+ */
4
+ export interface TunnelRequestOptions {
5
+ /**
6
+ * Gets or sets an access token for the request.
7
+ *
8
+ * Note this should not be a _user_ access token (such as AAD or GitHub); use the
9
+ * callback parameter to the `TunnelManagementHttpClient` constructor to
10
+ * supply user access tokens.
11
+ */
12
+ accessToken?: string;
13
+ /**
14
+ * Gets or sets additional headers to be included in the request.
15
+ */
16
+ additionalHeaders?: {
17
+ [header: string]: string;
18
+ };
19
+ /**
20
+ * Gets or sets additional query parameters to be included in the request.
21
+ */
22
+ additionalQueryParameters?: {
23
+ [name: string]: string;
24
+ };
25
+ /**
26
+ * Gets or sets a value that indicates whether HTTP redirect responses will be
27
+ * automatically followed.
28
+ *
29
+ * The default is true. If false, a redirect response will cause an error to be thrown,
30
+ * with redirect target URI available at `error.response.headers.location`.
31
+ *
32
+ * The tunnel service often redirects requests to the "home" cluster of the requested
33
+ * tunnel, when necessary to fulfill the request.
34
+ */
35
+ followRedirects?: boolean;
36
+ /**
37
+ * Gets or sets a flag that requests tunnel ports when retrieving a tunnel object.
38
+ */
39
+ includePorts?: boolean;
40
+ /**
41
+ * Gets or sets an optional list of tags to filter the requested tunnels or ports.
42
+ *
43
+ * Requested tags are compared to the `Tunnel.tags` or `TunnelPort.tags` when calling
44
+ * `TunnelManagementClient.listTunnels` or `TunnelManagementClient.listTunnelPorts`
45
+ * respectively. By default, an item is included if ANY tag matches; set `requireAllTags`
46
+ * to match ALL tags instead.
47
+ */
48
+ tags?: string[];
49
+ requireAllTags?: boolean;
50
+ /**
51
+ * Gets or sets an optional list of token scopes that are requested when retrieving a
52
+ * tunnel or tunnel port object.
53
+ *
54
+ * Each item in the array must be a single scope from `TunnelAccessScopes` or a space-
55
+ * delimited combination of multiple scopes. The service issues an access token for
56
+ * each scope or combination and returns the token(s) in the `Tunnel.accessTokens` or
57
+ * `TunnelPort.accessTokens` dictionary. If the caller does not have permission to get
58
+ * a token for one or more scopes then a token is not returned but the overall request
59
+ * does not fail. Token properties including scopes and expiration may be checked using
60
+ * `TunnelAccessTokenProperties`.
61
+ */
62
+ tokenScopes?: string[];
63
+ /**
64
+ * If true on a create or update request then upon a name conflict, attempt to rename the
65
+ * existing tunnel to null and give the name to the tunnel from the request.
66
+ */
67
+ forceRename?: boolean;
68
+ }
69
69
  //# sourceMappingURL=tunnelRequestOptions.d.ts.map
@@ -1,5 +1,5 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  //# sourceMappingURL=tunnelRequestOptions.js.map
package/version.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- /**
2
- * Tunnel SDK user agent
3
- */
4
- export declare const tunnelSdkUserAgent: string;
1
+ /**
2
+ * Tunnel SDK user agent
3
+ */
4
+ export declare const tunnelSdkUserAgent: string;
5
5
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,13 +1,13 @@
1
- "use strict";
2
- // Copyright (c) Microsoft Corporation.
3
- // Licensed under the MIT license.
4
- Object.defineProperty(exports, "__esModule", { value: true });
5
- exports.tunnelSdkUserAgent = void 0;
6
- // Get the package version
7
- const packageJson = require("./package.json");
8
- const packageVersion = packageJson.version;
9
- /**
10
- * Tunnel SDK user agent
11
- */
12
- exports.tunnelSdkUserAgent = `Visual-Studio-Tunnel-Service-SDK/${packageVersion}`;
1
+ "use strict";
2
+ // Copyright (c) Microsoft Corporation.
3
+ // Licensed under the MIT license.
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.tunnelSdkUserAgent = void 0;
6
+ // Get the package version
7
+ const packageJson = require("./package.json");
8
+ const packageVersion = packageJson.version;
9
+ /**
10
+ * Tunnel SDK user agent
11
+ */
12
+ exports.tunnelSdkUserAgent = `Visual-Studio-Tunnel-Service-SDK/${packageVersion}`;
13
13
  //# sourceMappingURL=version.js.map