@microsoft/dev-tunnels-contracts 1.0.8 → 1.0.7302

package/tunnel.d.ts

@@ -1,79 +1,79 @@
-import { TunnelAccessControl } from './tunnelAccessControl';
-import { TunnelEndpoint } from './tunnelEndpoint';
-import { TunnelOptions } from './tunnelOptions';
-import { TunnelPort } from './tunnelPort';
-import { TunnelStatus } from './tunnelStatus';
-/**
- * Data contract for tunnel objects managed through the tunnel service REST API.
- */
-export interface Tunnel {
-    /**
-     * 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 optional short name (alias) of the tunnel.
-     *
-     * The name must be globally unique within the parent domain, and must be a valid
-     * subdomain.
-     */
-    name?: string;
-    /**
-     * Gets or sets the description of the tunnel.
-     */
-    description?: string;
-    /**
-     * Gets or sets the tags of the tunnel.
-     */
-    tags?: string[];
-    /**
-     * Gets or sets the optional parent domain of the tunnel, if it is not using the
-     * default parent domain.
-     */
-    domain?: string;
-    /**
-     * Gets or sets a dictionary mapping from scopes to tunnel access tokens.
-     */
-    accessTokens?: {
-        [scope: string]: string;
-    };
-    /**
-     * Gets or sets access control settings for the tunnel.
-     *
-     * See {@link TunnelAccessControl} documentation for details about the access control
-     * model.
-     */
-    accessControl?: TunnelAccessControl;
-    /**
-     * Gets or sets default options for the tunnel.
-     */
-    options?: TunnelOptions;
-    /**
-     * Gets or sets current connection status of the tunnel.
-     */
-    status?: TunnelStatus;
-    /**
-     * Gets or sets an array of endpoints where hosts are currently accepting client
-     * connections to the tunnel.
-     */
-    endpoints?: TunnelEndpoint[];
-    /**
-     * Gets or sets a list of ports in the tunnel.
-     *
-     * This optional property enables getting info about all ports in a tunnel at the same
-     * time as getting tunnel info, or creating one or more ports at the same time as
-     * creating a tunnel. It is omitted when listing (multiple) tunnels, or when updating
-     * tunnel properties. (For the latter, use APIs to create/update/delete individual
-     * ports instead.)
-     */
-    ports?: TunnelPort[];
-    /**
-     * Gets or sets the time in UTC of tunnel creation.
-     */
-    created?: Date;
-}
+import { TunnelAccessControl } from './tunnelAccessControl';
+import { TunnelEndpoint } from './tunnelEndpoint';
+import { TunnelOptions } from './tunnelOptions';
+import { TunnelPort } from './tunnelPort';
+import { TunnelStatus } from './tunnelStatus';
+/**
+ * Data contract for tunnel objects managed through the tunnel service REST API.
+ */
+export interface Tunnel {
+    /**
+     * 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 optional short name (alias) of the tunnel.
+     *
+     * The name must be globally unique within the parent domain, and must be a valid
+     * subdomain.
+     */
+    name?: string;
+    /**
+     * Gets or sets the description of the tunnel.
+     */
+    description?: string;
+    /**
+     * Gets or sets the tags of the tunnel.
+     */
+    tags?: string[];
+    /**
+     * Gets or sets the optional parent domain of the tunnel, if it is not using the
+     * default parent domain.
+     */
+    domain?: string;
+    /**
+     * Gets or sets a dictionary mapping from scopes to tunnel access tokens.
+     */
+    accessTokens?: {
+        [scope: string]: string;
+    };
+    /**
+     * Gets or sets access control settings for the tunnel.
+     *
+     * See {@link TunnelAccessControl} documentation for details about the access control
+     * model.
+     */
+    accessControl?: TunnelAccessControl;
+    /**
+     * Gets or sets default options for the tunnel.
+     */
+    options?: TunnelOptions;
+    /**
+     * Gets or sets current connection status of the tunnel.
+     */
+    status?: TunnelStatus;
+    /**
+     * Gets or sets an array of endpoints where hosts are currently accepting client
+     * connections to the tunnel.
+     */
+    endpoints?: TunnelEndpoint[];
+    /**
+     * Gets or sets a list of ports in the tunnel.
+     *
+     * This optional property enables getting info about all ports in a tunnel at the same
+     * time as getting tunnel info, or creating one or more ports at the same time as
+     * creating a tunnel. It is omitted when listing (multiple) tunnels, or when updating
+     * tunnel properties. (For the latter, use APIs to create/update/delete individual
+     * ports instead.)
+     */
+    ports?: TunnelPort[];
+    /**
+     * Gets or sets the time in UTC of tunnel creation.
+     */
+    created?: Date;
+}
 //# sourceMappingURL=tunnel.d.ts.map

package/tunnel.js

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

package/tunnelAccessControl.d.ts

@@ -1,28 +1,28 @@
-import { TunnelAccessControlEntry } from './tunnelAccessControlEntry';
-/**
- * Data contract for access control on a {@link Tunnel} or {@link TunnelPort}.
- *
- * Tunnels and tunnel ports can each optionally have an access-control property set on
- * them. An access-control object contains a list (ACL) of entries (ACEs) that specify the
- * access scopes granted or denied to some subjects. Tunnel ports inherit the ACL from the
- * tunnel, though ports may include ACEs that augment or override the inherited rules.
- * Currently there is no capability to define "roles" for tunnel access (where a role
- * specifies a set of related access scopes), and assign roles to users. That feature may
- * be added in the future. (It should be represented as a separate `RoleAssignments`
- * property on this class.)
- */
-export interface TunnelAccessControl {
-    /**
-     * Gets or sets the list of access control entries.
-     *
-     * The order of entries is significant: later entries override earlier entries that
-     * apply to the same subject. However, deny rules are always processed after allow
-     * rules, therefore an allow rule cannot override a deny rule for the same subject.
-     */
-    entries: TunnelAccessControlEntry[];
-}
-import { validateScopes } from './tunnelAccessControlStatics';
-export declare const TunnelAccessControl: {
-    validateScopes: typeof validateScopes;
-};
+import { TunnelAccessControlEntry } from './tunnelAccessControlEntry';
+/**
+ * Data contract for access control on a {@link Tunnel} or {@link TunnelPort}.
+ *
+ * Tunnels and tunnel ports can each optionally have an access-control property set on
+ * them. An access-control object contains a list (ACL) of entries (ACEs) that specify the
+ * access scopes granted or denied to some subjects. Tunnel ports inherit the ACL from the
+ * tunnel, though ports may include ACEs that augment or override the inherited rules.
+ * Currently there is no capability to define "roles" for tunnel access (where a role
+ * specifies a set of related access scopes), and assign roles to users. That feature may
+ * be added in the future. (It should be represented as a separate `RoleAssignments`
+ * property on this class.)
+ */
+export interface TunnelAccessControl {
+    /**
+     * Gets or sets the list of access control entries.
+     *
+     * The order of entries is significant: later entries override earlier entries that
+     * apply to the same subject. However, deny rules are always processed after allow
+     * rules, therefore an allow rule cannot override a deny rule for the same subject.
+     */
+    entries: TunnelAccessControlEntry[];
+}
+import { validateScopes } from './tunnelAccessControlStatics';
+export declare const TunnelAccessControl: {
+    validateScopes: typeof validateScopes;
+};
 //# sourceMappingURL=tunnelAccessControl.d.ts.map

package/tunnelAccessControl.js

@@ -1,14 +1,14 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelAccessControl.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelAccessControl = void 0;
-// Import static members from a non-generated file,
-// and re-export them as an object with the same name as the interface.
-const tunnelAccessControlStatics_1 = require("./tunnelAccessControlStatics");
-exports.TunnelAccessControl = {
-    validateScopes: tunnelAccessControlStatics_1.validateScopes,
-};
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelAccessControl.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelAccessControl = void 0;
+// Import static members from a non-generated file,
+// and re-export them as an object with the same name as the interface.
+const tunnelAccessControlStatics_1 = require("./tunnelAccessControlStatics");
+exports.TunnelAccessControl = {
+    validateScopes: tunnelAccessControlStatics_1.validateScopes,
+};
 //# sourceMappingURL=tunnelAccessControl.js.map

package/tunnelAccessControlEntry.d.ts

@@ -1,80 +1,80 @@
-import { TunnelAccessControlEntryType } from './tunnelAccessControlEntryType';
-/**
- * Data contract for an access control entry on a {@link Tunnel} or {@link TunnelPort}.
- *
- * An access control entry (ACE) grants or denies one or more access scopes to one or more
- * subjects. Tunnel ports inherit access control entries from their tunnel, and they may
- * have additional port-specific entries that augment or override those access rules.
- */
-export interface TunnelAccessControlEntry {
-    /**
-     * Gets or sets the access control entry type.
-     */
-    type: TunnelAccessControlEntryType;
-    /**
-     * Gets or sets the provider of the subjects in this access control entry. The
-     * provider impacts how the subject identifiers are resolved and displayed. The
-     * provider may be an identity provider such as AAD, or a system or standard such as
-     * "ssh" or "ipv4".
-     *
-     * For user, group, or org ACEs, this value is the name of the identity provider of
-     * the user/group/org IDs. It may be one of the well-known provider names in {@link
-     * TunnelAccessControlEntry.providers}, or (in the future) a custom identity provider.
-     *  For public key ACEs, this value is the type of public key, e.g. "ssh".  For IP
-     * address range ACEs, this value is the IP address version, "ipv4" or "ipv6", or
-     * "service-tag" if the range is defined by an Azure service tag.  For anonymous ACEs,
-     * this value is null.
-     */
-    provider?: string;
-    /**
-     * Gets or sets a value indicating whether this is an access control entry on a tunnel
-     * port that is inherited from the tunnel's access control list.
-     */
-    isInherited?: boolean;
-    /**
-     * Gets or sets a value indicating whether this entry is a deny rule that blocks
-     * access to the specified users. Otherwise it is an allow rule.
-     *
-     * All deny rules (including inherited rules) are processed after all allow rules.
-     * Therefore a deny ACE cannot be overridden by an allow ACE that is later in the list
-     * or on a more-specific resource. In other words, inherited deny ACEs cannot be
-     * overridden.
-     */
-    isDeny?: boolean;
-    /**
-     * Gets or sets a value indicating whether this entry applies to all subjects that are
-     * NOT in the {@link TunnelAccessControlEntry.subjects} list.
-     *
-     * Examples: an inverse organizations ACE applies to all users who are not members of
-     * the listed organization(s); an inverse anonymous ACE applies to all authenticated
-     * users; an inverse IP address ranges ACE applies to all clients that are not within
-     * any of the listed IP address ranges. The inverse option is often useful in policies
-     * in combination with {@link TunnelAccessControlEntry.isDeny}, for example a policy
-     * could deny access to users who are not members of an organization or are outside of
-     * an IP address range, effectively blocking any tunnels from allowing outside access
-     * (because inherited deny ACEs cannot be overridden).
-     */
-    isInverse?: boolean;
-    /**
-     * Gets or sets an optional organization context for all subjects of this entry. The
-     * use and meaning of this value depends on the {@link TunnelAccessControlEntry.type}
-     * and {@link TunnelAccessControlEntry.provider} of this entry.
-     *
-     * For AAD users and group ACEs, this value is the AAD tenant ID. It is not currently
-     * used with any other types of ACEs.
-     */
-    organization?: string;
-    /**
-     * Gets or sets the subjects for the entry, such as user or group IDs. The format of
-     * the values depends on the {@link TunnelAccessControlEntry.type} and {@link
-     * TunnelAccessControlEntry.provider} of this entry.
-     */
-    subjects: string[];
-    /**
-     * Gets or sets the access scopes that this entry grants or denies to the subjects.
-     *
-     * These must be one or more values from {@link TunnelAccessScopes}.
-     */
-    scopes: string[];
-}
+import { TunnelAccessControlEntryType } from './tunnelAccessControlEntryType';
+/**
+ * Data contract for an access control entry on a {@link Tunnel} or {@link TunnelPort}.
+ *
+ * An access control entry (ACE) grants or denies one or more access scopes to one or more
+ * subjects. Tunnel ports inherit access control entries from their tunnel, and they may
+ * have additional port-specific entries that augment or override those access rules.
+ */
+export interface TunnelAccessControlEntry {
+    /**
+     * Gets or sets the access control entry type.
+     */
+    type: TunnelAccessControlEntryType;
+    /**
+     * Gets or sets the provider of the subjects in this access control entry. The
+     * provider impacts how the subject identifiers are resolved and displayed. The
+     * provider may be an identity provider such as AAD, or a system or standard such as
+     * "ssh" or "ipv4".
+     *
+     * For user, group, or org ACEs, this value is the name of the identity provider of
+     * the user/group/org IDs. It may be one of the well-known provider names in {@link
+     * TunnelAccessControlEntry.providers}, or (in the future) a custom identity provider.
+     *  For public key ACEs, this value is the type of public key, e.g. "ssh".  For IP
+     * address range ACEs, this value is the IP address version, "ipv4" or "ipv6", or
+     * "service-tag" if the range is defined by an Azure service tag.  For anonymous ACEs,
+     * this value is null.
+     */
+    provider?: string;
+    /**
+     * Gets or sets a value indicating whether this is an access control entry on a tunnel
+     * port that is inherited from the tunnel's access control list.
+     */
+    isInherited?: boolean;
+    /**
+     * Gets or sets a value indicating whether this entry is a deny rule that blocks
+     * access to the specified users. Otherwise it is an allow rule.
+     *
+     * All deny rules (including inherited rules) are processed after all allow rules.
+     * Therefore a deny ACE cannot be overridden by an allow ACE that is later in the list
+     * or on a more-specific resource. In other words, inherited deny ACEs cannot be
+     * overridden.
+     */
+    isDeny?: boolean;
+    /**
+     * Gets or sets a value indicating whether this entry applies to all subjects that are
+     * NOT in the {@link TunnelAccessControlEntry.subjects} list.
+     *
+     * Examples: an inverse organizations ACE applies to all users who are not members of
+     * the listed organization(s); an inverse anonymous ACE applies to all authenticated
+     * users; an inverse IP address ranges ACE applies to all clients that are not within
+     * any of the listed IP address ranges. The inverse option is often useful in policies
+     * in combination with {@link TunnelAccessControlEntry.isDeny}, for example a policy
+     * could deny access to users who are not members of an organization or are outside of
+     * an IP address range, effectively blocking any tunnels from allowing outside access
+     * (because inherited deny ACEs cannot be overridden).
+     */
+    isInverse?: boolean;
+    /**
+     * Gets or sets an optional organization context for all subjects of this entry. The
+     * use and meaning of this value depends on the {@link TunnelAccessControlEntry.type}
+     * and {@link TunnelAccessControlEntry.provider} of this entry.
+     *
+     * For AAD users and group ACEs, this value is the AAD tenant ID. It is not currently
+     * used with any other types of ACEs.
+     */
+    organization?: string;
+    /**
+     * Gets or sets the subjects for the entry, such as user or group IDs. The format of
+     * the values depends on the {@link TunnelAccessControlEntry.type} and {@link
+     * TunnelAccessControlEntry.provider} of this entry.
+     */
+    subjects: string[];
+    /**
+     * Gets or sets the access scopes that this entry grants or denies to the subjects.
+     *
+     * These must be one or more values from {@link TunnelAccessScopes}.
+     */
+    scopes: string[];
+}
 //# sourceMappingURL=tunnelAccessControlEntry.d.ts.map

package/tunnelAccessControlEntry.js

@@ -1,40 +1,40 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelAccessControlEntry.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-var TunnelAccessControlEntry;
-(function (TunnelAccessControlEntry) {
-    /**
-     * Constants for well-known identity providers.
-     */
-    let Providers;
-    (function (Providers) {
-        /**
-         * Microsoft (AAD) identity provider.
-         */
-        Providers["Microsoft"] = "microsoft";
-        /**
-         * GitHub identity provider.
-         */
-        Providers["GitHub"] = "github";
-        /**
-         * SSH public keys.
-         */
-        Providers["Ssh"] = "ssh";
-        /**
-         * IPv4 addresses.
-         */
-        Providers["IPv4"] = "ipv4";
-        /**
-         * IPv6 addresses.
-         */
-        Providers["IPv6"] = "ipv6";
-        /**
-         * Service tags.
-         */
-        Providers["ServiceTag"] = "service-tag";
-    })(Providers = TunnelAccessControlEntry.Providers || (TunnelAccessControlEntry.Providers = {}));
-})(TunnelAccessControlEntry || (TunnelAccessControlEntry = {}));
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelAccessControlEntry.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+var TunnelAccessControlEntry;
+(function (TunnelAccessControlEntry) {
+    /**
+     * Constants for well-known identity providers.
+     */
+    let Providers;
+    (function (Providers) {
+        /**
+         * Microsoft (AAD) identity provider.
+         */
+        Providers["Microsoft"] = "microsoft";
+        /**
+         * GitHub identity provider.
+         */
+        Providers["GitHub"] = "github";
+        /**
+         * SSH public keys.
+         */
+        Providers["Ssh"] = "ssh";
+        /**
+         * IPv4 addresses.
+         */
+        Providers["IPv4"] = "ipv4";
+        /**
+         * IPv6 addresses.
+         */
+        Providers["IPv6"] = "ipv6";
+        /**
+         * Service tags.
+         */
+        Providers["ServiceTag"] = "service-tag";
+    })(Providers = TunnelAccessControlEntry.Providers || (TunnelAccessControlEntry.Providers = {}));
+})(TunnelAccessControlEntry || (TunnelAccessControlEntry = {}));
 //# sourceMappingURL=tunnelAccessControlEntry.js.map

package/tunnelAccessControlEntryType.d.ts

@@ -1,46 +1,46 @@
-/**
- * Specifies the type of {@link TunnelAccessControlEntry}.
- */
-export declare enum TunnelAccessControlEntryType {
-    /**
-     * Uninitialized access control entry type.
-     */
-    None = "None",
-    /**
-     * The access control entry refers to all anonymous users.
-     */
-    Anonymous = "Anonymous",
-    /**
-     * The access control entry is a list of user IDs that are allowed (or denied) access.
-     */
-    Users = "Users",
-    /**
-     * The access control entry is a list of groups IDs that are allowed (or denied)
-     * access.
-     */
-    Groups = "Groups",
-    /**
-     * The access control entry is a list of organization IDs that are allowed (or denied)
-     * access.
-     *
-     * All users in the organizations are allowed (or denied) access, unless overridden by
-     * following group or user rules.
-     */
-    Organizations = "Organizations",
-    /**
-     * The access control entry is a list of repositories. Users are allowed access to the
-     * tunnel if they have access to the repo.
-     */
-    Repositories = "Repositories",
-    /**
-     * The access control entry is a list of public keys. Users are allowed access if they
-     * can authenticate using a private key corresponding to one of the public keys.
-     */
-    PublicKeys = "PublicKeys",
-    /**
-     * The access control entry is a list of IP address ranges that are allowed (or
-     * denied) access to the tunnel. Ranges can be IPv4, IPv6, or Azure service tags.
-     */
-    IPAddressRanges = "IPAddressRanges"
-}
+/**
+ * Specifies the type of {@link TunnelAccessControlEntry}.
+ */
+export declare enum TunnelAccessControlEntryType {
+    /**
+     * Uninitialized access control entry type.
+     */
+    None = "None",
+    /**
+     * The access control entry refers to all anonymous users.
+     */
+    Anonymous = "Anonymous",
+    /**
+     * The access control entry is a list of user IDs that are allowed (or denied) access.
+     */
+    Users = "Users",
+    /**
+     * The access control entry is a list of groups IDs that are allowed (or denied)
+     * access.
+     */
+    Groups = "Groups",
+    /**
+     * The access control entry is a list of organization IDs that are allowed (or denied)
+     * access.
+     *
+     * All users in the organizations are allowed (or denied) access, unless overridden by
+     * following group or user rules.
+     */
+    Organizations = "Organizations",
+    /**
+     * The access control entry is a list of repositories. Users are allowed access to the
+     * tunnel if they have access to the repo.
+     */
+    Repositories = "Repositories",
+    /**
+     * The access control entry is a list of public keys. Users are allowed access if they
+     * can authenticate using a private key corresponding to one of the public keys.
+     */
+    PublicKeys = "PublicKeys",
+    /**
+     * The access control entry is a list of IP address ranges that are allowed (or
+     * denied) access to the tunnel. Ranges can be IPv4, IPv6, or Azure service tags.
+     */
+    IPAddressRanges = "IPAddressRanges"
+}
 //# sourceMappingURL=tunnelAccessControlEntryType.d.ts.map