api: add optional createIfNone to AzureAuthentication.getSessionWithScopes (#1466)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: alexweininger

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## Unreleased
+
+### Added
+* Add an optional `options` parameter to `AzureAuthentication.getSessionWithScopes`. Passing `{ createIfNone: true }` allows an interactive consent prompt when a session for the requested scopes has not yet been granted. See [microsoft/vscode-azurefunctions#5073](https://github.com/microsoft/vscode-azurefunctions/issues/5073)
+
 ## 0.12.5 - 2026-05-28
 
 ### Changed

api/docs/vscode-azureresources-api.d.ts

@@ -126,10 +126,13 @@ export declare interface AzureAuthentication {
      *
      * @param scopeListOrRequest - The scopes for which the authentication is needed. Use AuthenticationWwwAuthenticateRequest for supporting challenge requests.
      * Note: use of AuthenticationWwwAuthenticateRequest requires VS Code v1.105.0
+     * @param options - (Optional) Options controlling how the session is acquired. By default a plain
+     * scope list is acquired silently; set `createIfNone` to allow an interactive consent prompt when
+     * no session for the requested scopes has been granted yet. Challenge requests always allow prompting.
      *
      * @returns A VS Code authentication session or undefined, if none could be obtained.
      */
-    getSessionWithScopes(scopeListOrRequest: string[] | vscode.AuthenticationWwwAuthenticateRequest): vscode.ProviderResult<vscode.AuthenticationSession>;
+    getSessionWithScopes(scopeListOrRequest: string[] | vscode.AuthenticationWwwAuthenticateRequest, options?: GetSessionWithScopesOptions): vscode.ProviderResult<vscode.AuthenticationSession>;
 }
 
 export declare interface AzureExtensionApi {
@@ -396,6 +399,17 @@ export declare function getAzExtResourceType(resource: {
  * */
 export declare function getAzureResourcesExtensionApi(extensionContext: vscode.ExtensionContext, apiVersionRange: '2.0.0', options?: GetApiOptions): Promise<AzureResourcesExtensionApi>;
 
+/**
+ * Options for {@link AzureAuthentication.getSessionWithScopes}.
+ */
+export declare interface GetSessionWithScopesOptions {
+    /**
+     * Whether to allow an interactive prompt (sign in / consent) if no session for the requested
+     * scopes is already available. Defaults to `false`, in which case the session is acquired silently.
+     */
+    createIfNone?: boolean;
+}
+
 export declare function isWrapper(maybeWrapper: unknown): maybeWrapper is Wrapper;
 
 /**

api/src/resources/azure.ts

@@ -24,10 +24,24 @@ export interface AzureAuthentication {
      *
      * @param scopeListOrRequest - The scopes for which the authentication is needed. Use AuthenticationWwwAuthenticateRequest for supporting challenge requests.
      * Note: use of AuthenticationWwwAuthenticateRequest requires VS Code v1.105.0
+     * @param options - (Optional) Options controlling how the session is acquired. By default a plain
+     * scope list is acquired silently; set `createIfNone` to allow an interactive consent prompt when
+     * no session for the requested scopes has been granted yet. Challenge requests always allow prompting.
      *
      * @returns A VS Code authentication session or undefined, if none could be obtained.
      */
-    getSessionWithScopes(scopeListOrRequest: string[] | vscode.AuthenticationWwwAuthenticateRequest): vscode.ProviderResult<vscode.AuthenticationSession>;
+    getSessionWithScopes(scopeListOrRequest: string[] | vscode.AuthenticationWwwAuthenticateRequest, options?: GetSessionWithScopesOptions): vscode.ProviderResult<vscode.AuthenticationSession>;
+}
+
+/**
+ * Options for {@link AzureAuthentication.getSessionWithScopes}.
+ */
+export interface GetSessionWithScopesOptions {
+    /**
+     * Whether to allow an interactive prompt (sign in / consent) if no session for the requested
+     * scopes is already available. Defaults to `false`, in which case the session is acquired silently.
+     */
+    createIfNone?: boolean;
 }
 
 /**