@microsoft/dev-tunnels-contracts 1.3.5 → 1.3.36

package/tunnelAccessControlEntry.d.ts

@@ -1,117 +1,117 @@
-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[];
-    /**
-     * Gets or sets the expiration for an access control entry.
-     *
-     * If no value is set then this value is null.
-     */
-    expiration?: Date;
-}
-export declare namespace TunnelAccessControlEntry {
-    /**
-     * Constants for well-known identity providers.
-     */
-    enum Providers {
-        /**
-         * Microsoft (AAD) identity provider.
-         */
-        Microsoft = "microsoft",
-        /**
-         * GitHub identity provider.
-         */
-        GitHub = "github",
-        /**
-         * SSH public keys.
-         */
-        Ssh = "ssh",
-        /**
-         * IPv4 addresses.
-         */
-        IPv4 = "ipv4",
-        /**
-         * IPv6 addresses.
-         */
-        IPv6 = "ipv6",
-        /**
-         * Service tags.
-         */
-        ServiceTag = "service-tag"
-    }
-}
+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[];
+    /**
+     * Gets or sets the expiration for an access control entry.
+     *
+     * If no value is set then this value is null.
+     */
+    expiration?: Date;
+}
+export declare namespace TunnelAccessControlEntry {
+    /**
+     * Constants for well-known identity providers.
+     */
+    enum Providers {
+        /**
+         * Microsoft (AAD) identity provider.
+         */
+        Microsoft = "microsoft",
+        /**
+         * GitHub identity provider.
+         */
+        GitHub = "github",
+        /**
+         * SSH public keys.
+         */
+        Ssh = "ssh",
+        /**
+         * IPv4 addresses.
+         */
+        IPv4 = "ipv4",
+        /**
+         * IPv6 addresses.
+         */
+        IPv6 = "ipv6",
+        /**
+         * Service tags.
+         */
+        ServiceTag = "service-tag"
+    }
+}
 //# sourceMappingURL=tunnelAccessControlEntry.d.ts.map

package/tunnelAccessControlEntry.js

@@ -1,41 +1,41 @@
-"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 });
-exports.TunnelAccessControlEntry = void 0;
-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 = exports.TunnelAccessControlEntry || (exports.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 });
+exports.TunnelAccessControlEntry = void 0;
+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 = exports.TunnelAccessControlEntry || (exports.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

package/tunnelAccessControlEntryType.js

@@ -1,54 +1,54 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelAccessControlEntryType.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelAccessControlEntryType = void 0;
-/**
- * Specifies the type of {@link TunnelAccessControlEntry}.
- */
-var TunnelAccessControlEntryType;
-(function (TunnelAccessControlEntryType) {
-    /**
-     * Uninitialized access control entry type.
-     */
-    TunnelAccessControlEntryType["None"] = "None";
-    /**
-     * The access control entry refers to all anonymous users.
-     */
-    TunnelAccessControlEntryType["Anonymous"] = "Anonymous";
-    /**
-     * The access control entry is a list of user IDs that are allowed (or denied) access.
-     */
-    TunnelAccessControlEntryType["Users"] = "Users";
-    /**
-     * The access control entry is a list of groups IDs that are allowed (or denied)
-     * access.
-     */
-    TunnelAccessControlEntryType["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.
-     */
-    TunnelAccessControlEntryType["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.
-     */
-    TunnelAccessControlEntryType["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.
-     */
-    TunnelAccessControlEntryType["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.
-     */
-    TunnelAccessControlEntryType["IPAddressRanges"] = "IPAddressRanges";
-})(TunnelAccessControlEntryType = exports.TunnelAccessControlEntryType || (exports.TunnelAccessControlEntryType = {}));
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelAccessControlEntryType.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelAccessControlEntryType = void 0;
+/**
+ * Specifies the type of {@link TunnelAccessControlEntry}.
+ */
+var TunnelAccessControlEntryType;
+(function (TunnelAccessControlEntryType) {
+    /**
+     * Uninitialized access control entry type.
+     */
+    TunnelAccessControlEntryType["None"] = "None";
+    /**
+     * The access control entry refers to all anonymous users.
+     */
+    TunnelAccessControlEntryType["Anonymous"] = "Anonymous";
+    /**
+     * The access control entry is a list of user IDs that are allowed (or denied) access.
+     */
+    TunnelAccessControlEntryType["Users"] = "Users";
+    /**
+     * The access control entry is a list of groups IDs that are allowed (or denied)
+     * access.
+     */
+    TunnelAccessControlEntryType["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.
+     */
+    TunnelAccessControlEntryType["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.
+     */
+    TunnelAccessControlEntryType["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.
+     */
+    TunnelAccessControlEntryType["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.
+     */
+    TunnelAccessControlEntryType["IPAddressRanges"] = "IPAddressRanges";
+})(TunnelAccessControlEntryType = exports.TunnelAccessControlEntryType || (exports.TunnelAccessControlEntryType = {}));
 //# sourceMappingURL=tunnelAccessControlEntryType.js.map

package/tunnelAccessControlStatics.d.ts

@@ -1,11 +1,11 @@
-/**
- * Checks that all items in an array of scopes are valid.
- * @param scopes List of scopes to validate.
- * @param validScopes Optional subset of scopes to be considered valid;
- * if omitted then all defined scopes are valid.
- * @param allowMultiple Whether to allow multiple space-delimited scopes in a single item.
- * Multiple scopes are supported when requesting a tunnel access token with a combination of scopes.
- * @throws Error if a scope is not valid.
- */
-export declare function validateScopes(scopes: string[], validScopes?: string[], allowMultiple?: boolean): void;
+/**
+ * Checks that all items in an array of scopes are valid.
+ * @param scopes List of scopes to validate.
+ * @param validScopes Optional subset of scopes to be considered valid;
+ * if omitted then all defined scopes are valid.
+ * @param allowMultiple Whether to allow multiple space-delimited scopes in a single item.
+ * Multiple scopes are supported when requesting a tunnel access token with a combination of scopes.
+ * @throws Error if a scope is not valid.
+ */
+export declare function validateScopes(scopes: string[], validScopes?: string[], allowMultiple?: boolean): void;
 //# sourceMappingURL=tunnelAccessControlStatics.d.ts.map

package/tunnelAccessControlStatics.js

@@ -1,47 +1,47 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateScopes = void 0;
-const tunnelAccessScopes_1 = require("./tunnelAccessScopes");
-const allScopes = [
-    tunnelAccessScopes_1.TunnelAccessScopes.Manage,
-    tunnelAccessScopes_1.TunnelAccessScopes.ManagePorts,
-    tunnelAccessScopes_1.TunnelAccessScopes.Host,
-    tunnelAccessScopes_1.TunnelAccessScopes.Inspect,
-    tunnelAccessScopes_1.TunnelAccessScopes.Connect,
-];
-/**
- * Checks that all items in an array of scopes are valid.
- * @param scopes List of scopes to validate.
- * @param validScopes Optional subset of scopes to be considered valid;
- * if omitted then all defined scopes are valid.
- * @param allowMultiple Whether to allow multiple space-delimited scopes in a single item.
- * Multiple scopes are supported when requesting a tunnel access token with a combination of scopes.
- * @throws Error if a scope is not valid.
- */
-function validateScopes(scopes, validScopes, allowMultiple) {
-    if (!Array.isArray(scopes)) {
-        throw new TypeError('A scopes array was expected.');
-    }
-    if (allowMultiple) {
-        scopes = scopes.map((s) => s.split(' ')).reduce((a, b) => a.concat(b), []);
-    }
-    scopes.forEach((scope) => {
-        if (!scope) {
-            throw new Error('Tunnel access scopes include a null/empty item.');
-        }
-        else if (!allScopes.includes(scope)) {
-            throw new Error('Invalid tunnel access scope: ' + scope);
-        }
-    });
-    if (Array.isArray(validScopes)) {
-        scopes.forEach((scope) => {
-            if (!validScopes.includes(scope)) {
-                throw new Error('Tunnel access scope is invalid for current request: scope');
-            }
-        });
-    }
-}
-exports.validateScopes = validateScopes;
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateScopes = void 0;
+const tunnelAccessScopes_1 = require("./tunnelAccessScopes");
+const allScopes = [
+    tunnelAccessScopes_1.TunnelAccessScopes.Manage,
+    tunnelAccessScopes_1.TunnelAccessScopes.ManagePorts,
+    tunnelAccessScopes_1.TunnelAccessScopes.Host,
+    tunnelAccessScopes_1.TunnelAccessScopes.Inspect,
+    tunnelAccessScopes_1.TunnelAccessScopes.Connect,
+];
+/**
+ * Checks that all items in an array of scopes are valid.
+ * @param scopes List of scopes to validate.
+ * @param validScopes Optional subset of scopes to be considered valid;
+ * if omitted then all defined scopes are valid.
+ * @param allowMultiple Whether to allow multiple space-delimited scopes in a single item.
+ * Multiple scopes are supported when requesting a tunnel access token with a combination of scopes.
+ * @throws Error if a scope is not valid.
+ */
+function validateScopes(scopes, validScopes, allowMultiple) {
+    if (!Array.isArray(scopes)) {
+        throw new TypeError('A scopes array was expected.');
+    }
+    if (allowMultiple) {
+        scopes = scopes.map((s) => s.split(' ')).reduce((a, b) => a.concat(b), []);
+    }
+    scopes.forEach((scope) => {
+        if (!scope) {
+            throw new Error('Tunnel access scopes include a null/empty item.');
+        }
+        else if (!allScopes.includes(scope)) {
+            throw new Error('Invalid tunnel access scope: ' + scope);
+        }
+    });
+    if (Array.isArray(validScopes)) {
+        scopes.forEach((scope) => {
+            if (!validScopes.includes(scope)) {
+                throw new Error('Tunnel access scope is invalid for current request: scope');
+            }
+        });
+    }
+}
+exports.validateScopes = validateScopes;
 //# sourceMappingURL=tunnelAccessControlStatics.js.map