@microsoft/vscode-azext-azureauth 2.5.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Change Log
 
+## 3.0.1 - 2024-11-19
+* [#1819](https://github.com/microsoft/vscode-azuretools/pull/1819) Add account parameter to `AzureSubscriptionProvider.isSignedIn()` function to fix a multi-account issue [#1809](https://github.com/microsoft/vscode-azuretools/issues/1809)
+* [#1822](https://github.com/microsoft/vscode-azuretools/pull/1822) Add check in `VSCodeAzureSubscriptionProvider.getTenants()` to fix a multi-account issue [#1809](https://github.com/microsoft/vscode-azuretools/issues/1809)
+
+## 3.0.0 - 2024-09-19
+* [#1789](https://github.com/microsoft/vscode-azuretools/pull/1789) Change `getTenants` to be compatible with the new Azure Resources tenants view. This also includes a possible breaking change where an optional parameter `account` which when passed in `getTenants` will return the tenants associated with that single account. Otherwise `getTenants` will return the tenants for all authenticated accounts.
+
+## 2.5.0 - 2024-08-06
+
+* Add `getSessionWithScopes` to get a session that has the proper scoping instead of always the default management plane
+
+## 2.4.1 - 2024-05-15
+
+* [#1729](https://github.com/microsoft/vscode-azuretools/pull/1729) Change AzureDevOpsSubscriptionProvider so that it accepts values as arguments
+
+## 2.4.0 - 2024-05-07
+
+* [#1723](https://github.com/microsoft/vscode-azuretools/pull/1723) Implementation fo AzureSub provider that leverages federated credentials
+
+## 2.1.0 - 2023-12-13
+
+* Use management endpoint for scope by default to fix deploying app service projects with sovereign clouds
+
+## 2.0.0 - 2023-11-20
+
+* Switches to use `@azure/arm-resources-subscriptions` instead of `@azure/arm-subscriptions`. Potentially a breaking change so I revved the major version.
+* Fixes an issue where the `endpoint` wasn't set for the subscription client, breaking sovereign clouds
+
 ## 1.4.0 - 2023-11-03
 * [#1619](https://github.com/microsoft/vscode-azuretools/pull/1619) Make `getSession` synchronous to fix an issue that broke app service deployments
 

package/out/src/AzureAuthentication.d.ts

@@ -5,7 +5,7 @@ import type * as vscode from 'vscode';
 export interface AzureAuthentication {
     /**
      * Gets a VS Code authentication session for an Azure subscription.
-     * Always uses the default scope, `https://management.azure.com/.default/.default.`
+     * Always uses the default scope, `https://management.azure.com/.default/` and respects `microsoft-sovereign-cloud.environment` setting.
      *
      * @returns A VS Code authentication session or undefined, if none could be obtained.
      */

package/out/src/AzureDevOpsSubscriptionProvider.js

@@ -119,6 +119,10 @@ class AzureDevOpsSubscriptionProvider {
                             subscriptionId: subscription.subscriptionId,
                             /* eslint-enable @typescript-eslint/no-non-null-assertion */
                             tenantId,
+                            account: {
+                                id: "test-account-id",
+                                label: "test-account",
+                            },
                         });
                     }
                     finally {

package/out/src/AzureSubscription.d.ts

@@ -1,6 +1,7 @@
 import type { TokenCredential } from '@azure/core-auth';
 import type { Environment } from '@azure/ms-rest-azure-env';
-import type { AzureAuthentication } from './AzureAuthentication';
+import * as vscode from "vscode";
+import { AzureAuthentication } from './AzureAuthentication';
 /**
  * A type representing an Azure subscription ID, not including the tenant ID.
  */
@@ -41,4 +42,8 @@ export interface AzureSubscription {
      * The credential for authentication to this subscription. Compatible with Azure track 2 SDKs.
      */
     readonly credential: TokenCredential;
+    /**
+     * The account associated with this subscription.
+     */
+    readonly account: vscode.AuthenticationSessionAccountInformation;
 }

package/out/src/AzureSubscriptionProvider.d.ts

@@ -1,6 +1,6 @@
+import type { TenantIdDescription } from '@azure/arm-resources-subscriptions';
 import type * as vscode from 'vscode';
 import type { AzureSubscription } from './AzureSubscription';
-import type { TenantIdDescription } from '@azure/arm-resources-subscriptions';
 /**
  * An interface for obtaining Azure subscription information
  */
@@ -9,9 +9,11 @@ export interface AzureSubscriptionProvider {
      * Gets a list of tenants available to the user.
      * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
      *
+     * @param account - Optionally pass in a specific account to get tenants for.
+     *
      * @returns A list of tenants.
      */
-    getTenants(): Promise<TenantIdDescription[]>;
+    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<TenantIdDescription[]>;
     /**
      * Gets a list of Azure subscriptions available to the user.
      *
@@ -32,7 +34,7 @@ export interface AzureSubscriptionProvider {
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(tenantId?: string): Promise<boolean>;
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * Asks the user to sign in or pick an account to use.
      *

package/out/src/VSCodeAzureSubscriptionProvider.d.ts

@@ -1,7 +1,7 @@
 import type { TenantIdDescription } from '@azure/arm-resources-subscriptions';
 import * as vscode from 'vscode';
-import type { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscription';
-import type { AzureSubscriptionProvider } from './AzureSubscriptionProvider';
+import { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscription';
+import { AzureSubscriptionProvider } from './AzureSubscriptionProvider';
 /**
  * A class for obtaining Azure subscription information using VSCode's built-in authentication
  * provider.
@@ -17,9 +17,11 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * Gets a list of tenants available to the user.
      * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
      *
+     * @param account (Optional) A specific account to get tenants for. If not provided, all accounts will be used.
+     *
      * @returns A list of tenants.
      */
-    getTenants(): Promise<TenantIdDescription[]>;
+    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<TenantIdDescription[]>;
     /**
      * Gets a list of Azure subscriptions available to the user.
      *
@@ -40,7 +42,7 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(tenantId?: string): Promise<boolean>;
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * Asks the user to sign in or pick an account to use.
      *
@@ -87,6 +89,7 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * Gets the subscriptions for a given tenant.
      *
      * @param tenantId The tenant ID to get subscriptions for.
+     * @param account The account to get the subscriptions for.
      *
      * @returns The list of subscriptions for the tenant.
      */
@@ -95,6 +98,7 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * Gets a fully-configured subscription client for a given tenant ID
      *
      * @param tenantId (Optional) The tenant ID to get a client for
+     * @param account The account that you would like to get the session for
      *
      * @returns A client, the credential used by the client, and the authentication function
      */

package/out/src/VSCodeAzureSubscriptionProvider.js

@@ -22,8 +22,8 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VSCodeAzureSubscriptionProvider = void 0;
 const vscode = require("vscode");
-const NotSignedInError_1 = require("./NotSignedInError");
 const getSessionFromVSCode_1 = require("./getSessionFromVSCode");
+const NotSignedInError_1 = require("./NotSignedInError");
 const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
 const EventDebounce = 5 * 1000; // 5 seconds
 /**
@@ -71,30 +71,54 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * Gets a list of tenants available to the user.
      * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
      *
+     * @param account (Optional) A specific account to get tenants for. If not provided, all accounts will be used.
+     *
      * @returns A list of tenants.
      */
-    getTenants() {
-        var _a, e_1, _b, _c;
+    getTenants(account) {
+        var _a, e_1, _b, _c, _d, e_2, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = yield this.getSubscriptionClient();
             const results = [];
             try {
-                for (var _d = true, _e = __asyncValues(client.tenants.list()), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
-                    _c = _f.value;
-                    _d = false;
+                for (var _g = true, _h = __asyncValues(account ? [account] : yield vscode.authentication.getAccounts((0, configuredAzureEnv_1.getConfiguredAuthProviderId)())), _j; _j = yield _h.next(), _a = _j.done, !_a;) {
+                    _c = _j.value;
+                    _g = false;
                     try {
-                        const tenant = _c;
-                        results.push(tenant);
+                        account = _c;
+                        // Added check. Without this the getSubscriptionClient function throws the NotSignedInError
+                        if (yield this.isSignedIn(undefined, account)) {
+                            const { client } = yield this.getSubscriptionClient(account, undefined, undefined);
+                            try {
+                                for (var _k = true, _l = (e_2 = void 0, __asyncValues(client.tenants.list())), _m; _m = yield _l.next(), _d = _m.done, !_d;) {
+                                    _f = _m.value;
+                                    _k = false;
+                                    try {
+                                        const tenant = _f;
+                                        results.push(tenant);
+                                    }
+                                    finally {
+                                        _k = true;
+                                    }
+                                }
+                            }
+                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                            finally {
+                                try {
+                                    if (!_k && !_d && (_e = _l.return)) yield _e.call(_l);
+                                }
+                                finally { if (e_2) throw e_2.error; }
+                            }
+                        }
                     }
                     finally {
-                        _d = true;
+                        _g = true;
                     }
                 }
             }
             catch (e_1_1) { e_1 = { error: e_1_1 }; }
             finally {
                 try {
-                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+                    if (!_g && !_a && (_b = _h.return)) yield _b.call(_h);
                 }
                 finally { if (e_1) throw e_1.error; }
             }
@@ -120,20 +144,23 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
             const results = [];
             try {
                 this.suppressSignInEvents = true;
-                // Get the list of tenants
-                for (const tenant of yield this.getTenants()) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    const tenantId = tenant.tenantId;
-                    // If filtering is enabled, and the current tenant is not in that list, then skip it
-                    if (shouldFilterTenants && !tenantIds.includes(tenantId)) {
-                        continue;
-                    }
-                    // If the user is not signed in to this tenant, then skip it
-                    if (!(yield this.isSignedIn(tenantId))) {
-                        continue;
+                // Get the list of tenants from each account
+                const accounts = yield vscode.authentication.getAccounts((0, configuredAzureEnv_1.getConfiguredAuthProviderId)());
+                for (const account of accounts) {
+                    for (const tenant of yield this.getTenants(account)) {
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                        const tenantId = tenant.tenantId;
+                        // If filtering is enabled, and the current tenant is not in that list, then skip it
+                        if (shouldFilterTenants && !tenantIds.includes(tenantId)) {
+                            continue;
+                        }
+                        // If the user is not signed in to this tenant, then skip it
+                        if (!(yield this.isSignedIn(tenantId, account))) {
+                            continue;
+                        }
+                        // For each tenant, get the list of subscriptions
+                        results.push(...yield this.getSubscriptionsForTenant(tenantId, account));
                     }
-                    // For each tenant, get the list of subscriptions
-                    results.push(...yield this.getSubscriptionsForTenant(tenantId));
                 }
             }
             finally {
@@ -154,9 +181,9 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(tenantId) {
+    isSignedIn(tenantId, account) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true, account });
             return !!session;
         });
     }
@@ -217,13 +244,14 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * Gets the subscriptions for a given tenant.
      *
      * @param tenantId The tenant ID to get subscriptions for.
+     * @param account The account to get the subscriptions for.
      *
      * @returns The list of subscriptions for the tenant.
      */
-    getSubscriptionsForTenant(tenantId) {
-        var _a, e_2, _b, _c;
+    getSubscriptionsForTenant(tenantId, account) {
+        var _a, e_3, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, credential, authentication } = yield this.getSubscriptionClient(tenantId);
+            const { client, credential, authentication } = yield this.getSubscriptionClient(account, tenantId, undefined);
             const environment = (0, configuredAzureEnv_1.getConfiguredAzureEnv)();
             const subscriptions = [];
             try {
@@ -242,6 +270,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                             subscriptionId: subscription.subscriptionId,
                             /* eslint-enable @typescript-eslint/no-non-null-assertion */
                             tenantId: tenantId,
+                            account: account
                         });
                     }
                     finally {
@@ -249,12 +278,12 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                     }
                 }
             }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            catch (e_3_1) { e_3 = { error: e_3_1 }; }
             finally {
                 try {
                     if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
                 }
-                finally { if (e_2) throw e_2.error; }
+                finally { if (e_3) throw e_3.error; }
             }
             return subscriptions;
         });
@@ -263,13 +292,14 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * Gets a fully-configured subscription client for a given tenant ID
      *
      * @param tenantId (Optional) The tenant ID to get a client for
+     * @param account The account that you would like to get the session for
      *
      * @returns A client, the credential used by the client, and the authentication function
      */
-    getSubscriptionClient(tenantId, scopes) {
+    getSubscriptionClient(account, tenantId, scopes) {
         return __awaiter(this, void 0, void 0, function* () {
             const armSubs = yield Promise.resolve().then(() => require('@azure/arm-resources-subscriptions'));
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true, account });
             if (!session) {
                 throw new NotSignedInError_1.NotSignedInError();
             }
@@ -289,7 +319,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                 authentication: {
                     getSession: () => session,
                     getSessionWithScopes: (scopes) => {
-                        return (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
+                        return (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true, account });
                     },
                 }
             };

package/out/src/getSessionFromVSCode.js

@@ -14,8 +14,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSessionFromVSCode = void 0;
-const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
 const vscode = require("vscode");
+const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
 function ensureEndingSlash(value) {
     return value.endsWith('/') ? value : `${value}/`;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "2.5.0",
+    "version": "3.0.1",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",
@@ -41,7 +41,7 @@
         "@types/node-fetch": "2.6.7",
         "@types/semver": "^7.3.9",
         "@types/uuid": "^9.0.1",
-        "@types/vscode": "1.76.0",
+        "@types/vscode": "1.93.0",
         "@typescript-eslint/eslint-plugin": "^5.53.0",
         "@vscode/test-electron": "^2.3.8",
         "eslint": "^8.34.0",

package/out/src/signInToTenants.d.ts

@@ -1,6 +0,0 @@
-import type { AzureSubscriptionProvider } from "./AzureSubscriptionProvider";
-/**
- * Prompts user to select from a list of unauthenticated tenants.
- * Once selected, requests a new session from VS Code specifially for this tenant.
- */
-export declare function signInToTenant(subscriptionProvider: AzureSubscriptionProvider): Promise<void>;

package/out/src/signInToTenants.js

@@ -1,57 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-*  Copyright (c) Microsoft Corporation. All rights reserved.
-*  Licensed under the MIT License. See License.txt in the project root for license information.
-*--------------------------------------------------------------------------------------------*/
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.signInToTenant = void 0;
-const vscode = require("vscode");
-const getUnauthenticatedTenants_1 = require("./utils/getUnauthenticatedTenants");
-/**
- * Prompts user to select from a list of unauthenticated tenants.
- * Once selected, requests a new session from VS Code specifially for this tenant.
- */
-function signInToTenant(subscriptionProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const tenantId = yield pickTenant(subscriptionProvider);
-        if (tenantId) {
-            yield subscriptionProvider.signIn(tenantId);
-        }
-    });
-}
-exports.signInToTenant = signInToTenant;
-function pickTenant(subscriptionProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const pick = yield vscode.window.showQuickPick(getPicks(subscriptionProvider), {
-            placeHolder: 'Select Directory to Sign In To',
-            matchOnDescription: true,
-            ignoreFocusOut: true,
-        });
-        return pick === null || pick === void 0 ? void 0 : pick.tenant.tenantId;
-    });
-}
-function getPicks(subscriptionProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const unauthenticatedTenants = yield (0, getUnauthenticatedTenants_1.getUnauthenticatedTenants)(subscriptionProvider);
-        const picks = unauthenticatedTenants.map(tenant => {
-            var _a, _b, _c;
-            return ({
-                label: (_a = tenant.displayName) !== null && _a !== void 0 ? _a : '',
-                description: (_b = tenant.tenantId) !== null && _b !== void 0 ? _b : '',
-                detail: (_c = tenant.defaultDomain) !== null && _c !== void 0 ? _c : '',
-                tenant,
-            });
-        });
-        return picks;
-    });
-}
-//# sourceMappingURL=signInToTenants.js.map