auth: Add enhanced tenant support

auth/README.md

@@ -13,6 +13,14 @@ The `AzureSubscriptionProvider` interface describes the functions of this packag
  * An interface for obtaining Azure subscription information
  */
 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.
+     *
+     * @returns A list of tenants.
+     */
+    getTenants(): Promise<TenantIdDescription[]>;
+
     /**
      * Gets a list of Azure subscriptions available to the user.
      *
@@ -30,16 +38,20 @@ export interface AzureSubscriptionProvider {
     /**
      * Checks to see if a user is signed in.
      *
+     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(): Promise<boolean>;
+    isSignedIn(tenantId?: string): Promise<boolean>;
 
     /**
      * Asks the user to sign in or pick an account to use.
      *
+     * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     *
      * @returns True if the user is signed in, false otherwise.
      */
-    signIn(): Promise<boolean>;
+    signIn(tenantId?: string): Promise<boolean>;
 
     /**
      * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.

auth/package.json

@@ -52,6 +52,7 @@
     },
     "dependencies": {
         "@azure/arm-subscriptions": "^5.1.0",
-        "@azure/ms-rest-azure-env": "^2.0.0"
+        "@azure/ms-rest-azure-env": "^2.0.0",
+        "cross-fetch": "^4.0.0"
     }
 }

auth/src/AzureSubscriptionProvider.ts

@@ -5,11 +5,20 @@
 
 import type * as vscode from 'vscode';
 import type { AzureSubscription } from './AzureSubscription';
+import { TenantIdDescription } from '@azure/arm-subscriptions';
 
 /**
  * An interface for obtaining Azure subscription information
  */
 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.
+     *
+     * @returns A list of tenants.
+     */
+    getTenants(): Promise<TenantIdDescription[]>;
+
     /**
      * Gets a list of Azure subscriptions available to the user.
      *
@@ -27,16 +36,20 @@ export interface AzureSubscriptionProvider {
     /**
      * Checks to see if a user is signed in.
      *
+     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(): Promise<boolean>;
+    isSignedIn(tenantId?: string): Promise<boolean>;
 
     /**
      * Asks the user to sign in or pick an account to use.
      *
+     * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     *
      * @returns True if the user is signed in, false otherwise.
      */
-    signIn(): Promise<boolean>;
+    signIn(tenantId?: string): Promise<boolean>;
 
     /**
      * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.

auth/src/VSCodeAzureSubscriptionProvider.ts

@@ -11,6 +11,7 @@ import type { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscri
 import type { AzureSubscriptionProvider } from './AzureSubscriptionProvider';
 import { NotSignedInError } from './NotSignedInError';
 import { getConfiguredAuthProviderId, getConfiguredAzureEnv } from './utils/configuredAzureEnv';
+import fetch from 'cross-fetch';
 
 const EventDebounce = 5 * 1000; // 5 seconds
 
@@ -51,6 +52,21 @@ export class VSCodeAzureSubscriptionProvider extends vscode.Disposable implement
         });
     }
 
+    /**
+     * Gets a list of tenants available to the user.
+     * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
+     *
+     * @returns A list of tenants.
+     */
+    public async getTenants(): Promise<TenantIdDescription[]> {
+        const listTenantsResponse = await fetch('https://management.azure.com/tenants?api-version=2022-12-01', {
+            headers: {
+                Authorization: `Bearer ${await this.getToken()}`,
+            }
+        });
+        return (await listTenantsResponse.json() as { value: TenantIdDescription[] }).value;
+    }
+
     /**
      * Gets a list of Azure subscriptions available to the user.
      *
@@ -122,10 +138,12 @@ export class VSCodeAzureSubscriptionProvider extends vscode.Disposable implement
     /**
      * Asks the user to sign in or pick an account to use.
      *
+     * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     *
      * @returns True if the user is signed in, false otherwise.
      */
-    public async signIn(): Promise<boolean> {
-        const session = await vscode.authentication.getSession(getConfiguredAuthProviderId(), this.getDefaultScopes(), { createIfNone: true, clearSessionPreference: true });
+    public async signIn(tenantId?: string): Promise<boolean> {
+        const session = await vscode.authentication.getSession(getConfiguredAuthProviderId(), this.getScopes([], tenantId), { createIfNone: true, clearSessionPreference: true });
         return !!session;
     }
 
@@ -179,22 +197,6 @@ export class VSCodeAzureSubscriptionProvider extends vscode.Disposable implement
         return fullSubscriptionIds.map(id => id.split('/')[1]);
     }
 
-    /**
-     * Gets the tenants available to a user.
-     *
-     * @returns The list of tenants visible to the user.
-     */
-    private async getTenants(): Promise<TenantIdDescription[]> {
-        const { client } = await this.getSubscriptionClient();
-        const tenants: TenantIdDescription[] = [];
-
-        for await (const tenant of client.tenants.list()) {
-            tenants.push(tenant);
-        }
-
-        return tenants;
-    }
-
     /**
      * Gets the subscriptions for a given tenant.
      *
@@ -262,6 +264,16 @@ export class VSCodeAzureSubscriptionProvider extends vscode.Disposable implement
         };
     }
 
+    private async getToken(tenantId?: string): Promise<string> {
+        const session = await vscode.authentication.getSession(getConfiguredAuthProviderId(), this.getScopes([], tenantId), { createIfNone: false, silent: true });
+
+        if (!session) {
+            throw new NotSignedInError();
+        }
+
+        return session.accessToken;
+    }
+
     /**
      * Gets a normalized list of scopes
      *