Support for domain name label scopes (#4909)

MicroFish91 · web-flow · commit 087b06dc0195 · 2026-03-02T11:29:09.000-08:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1474,7 +1474,7 @@
     },
     "dependencies": {
         "@azure/arm-appinsights": "^5.0.0-alpha.20230530.1",
-        "@azure/arm-appservice": "^15.0.0",
+        "@azure/arm-appservice": "^18.0.0",
         "@azure/arm-cosmosdb": "^15.0.0",
         "@azure/arm-eventhub": "^5.1.0",
         "@azure/arm-resourcegraph": "^5.0.0-beta.3",
@@ -1485,7 +1485,7 @@
         "@azure/core-client": "^1.7.3",
         "@azure/core-rest-pipeline": "^1.11.0",
         "@azure/storage-blob": "^12.5.0",
-        "@microsoft/vscode-azext-azureappservice": "^4.0.1",
+        "@microsoft/vscode-azext-azureappservice": "^4.1.0",
         "@microsoft/vscode-azext-azureappsettings": "^1.0.0",
         "@microsoft/vscode-azext-azureutils": "^4.0.1",
         "@microsoft/vscode-azext-utils": "^4.0.3",
diff --git a/src/FunctionAppResolver.ts b/src/FunctionAppResolver.ts
@@ -11,6 +11,7 @@ import { type AppResource, type AppResourceResolver } from "@microsoft/vscode-az
 import { ResolvedFunctionAppResource } from "./tree/ResolvedFunctionAppResource";
 import { ResolvedContainerizedFunctionAppResource } from "./tree/containerizedFunctionApp/ResolvedContainerizedFunctionAppResource";
 import { createResourceGraphClient } from "./utils/azureClients";
+import { getGlobalSetting } from "./vsCodeConfig/settings";
 
 export type FunctionAppModel = {
     isFlex: boolean,
@@ -39,6 +40,7 @@ export class FunctionAppResolver implements AppResourceResolver {
     private loaded: boolean = false;
     private siteCacheLastUpdated = 0;
     private siteCache: Map<string, FunctionAppModel> = new Map<string, FunctionAppModel>();
+    private siteNameCounter: Map<string, number> = new Map<string, number>();
     private listFunctionAppsTask: Promise<void> | undefined;
 
     public async resolveResource(subContext: ISubscriptionContext, resource: AppResource): Promise<ResolvedFunctionAppResource | ResolvedContainerizedFunctionAppResource | undefined> {
@@ -48,8 +50,10 @@ export class FunctionAppResolver implements AppResourceResolver {
                 // do this before the graph client is created because the async graph client create takes enough time to mess up the following resolves
                 this.loaded = false;
                 this.siteCache.clear(); // clear the cache before fetching new data
+                this.siteNameCounter.clear();
                 this.siteCacheLastUpdated = Date.now();
                 const graphClient = await createResourceGraphClient({ ...context, ...subContext });
+
                 async function fetchAllApps(graphClient: ResourceGraphClient, subContext: ISubscriptionContext, resolver: FunctionAppResolver): Promise<void> {
                     const query = `resources | where type == 'microsoft.web/sites' and kind contains 'functionapp' and kind !contains 'workflowapp'`;
 
@@ -65,6 +69,7 @@ export class FunctionAppResolver implements AppResourceResolver {
                         const record = response.data as Record<string, FunctionQueryModel>;
                         // seems as if properties can be null, so we need to check for that
                         Object.values(record).forEach(data => {
+                            resolver.countSiteName(data.name);
                             const dataModel: FunctionAppModel = {
                                 isFlex: data.properties?.sku?.toLocaleLowerCase() === 'flexconsumption',
                                 id: data.id,
@@ -98,18 +103,36 @@ export class FunctionAppResolver implements AppResourceResolver {
                 await this.listFunctionAppsTask;
             }
 
+            const groupBy: string | undefined = getGlobalSetting<string>('groupBy', 'azureResourceGroups');
+            const hasDuplicateSiteName: boolean = (this.siteNameCounter.get(resource.name) ?? 1) > 1;
+
             const siteModel = this.siteCache.get(nonNullProp(resource, 'id').toLowerCase());
             if (!siteModel || siteModel.kind === 'functionapp,linux,container,azurecontainerapps') {
+                // Edge Case: `siteModel` can be `undefined` after calling `createFunctionApp` because the result does not propagate to MS Graph in time; a fallback fetch + count is needed
+                if (!siteModel) {
+                    this.countSiteName(resource.name);
+                }
+
                 // if the site model is not found or if it's a containerized function app, we need the full site details
                 const client = await createWebSiteClient({ ...context, ...subContext });
                 const fullSite = await client.webApps.get(getResourceGroupFromId(resource.id), resource.name);
+
                 if (fullSite.kind === 'functionapp,linux,container,azurecontainerapps') {
-                    return ResolvedContainerizedFunctionAppResource.createResolvedFunctionAppResource(context, subContext, fullSite);
+                    return ResolvedContainerizedFunctionAppResource.createResolvedFunctionAppResource(context, subContext, fullSite, {
+                        // Display the location as well if there is a duplicate name, otherwise they won't be easily distinguishable in the tree view
+                        showLocationInTreeItemDescription: groupBy === 'resourceType' && hasDuplicateSiteName,
+                    });
                 }
 
-                return new ResolvedFunctionAppResource(subContext, fullSite);
+                return new ResolvedFunctionAppResource(subContext, fullSite, undefined, {
+                    // Display the location as well if there is a duplicate name, otherwise they won't be easily distinguishable in the tree view
+                    showLocationInTreeItemDescription: groupBy === 'resourceType' && hasDuplicateSiteName,
+                });
             } else if (siteModel) {
-                return new ResolvedFunctionAppResource(subContext, undefined, siteModel);
+                return new ResolvedFunctionAppResource(subContext, undefined, siteModel, {
+                    // Display the location as well if there is a duplicate name, otherwise they won't be easily distinguishable in the tree view
+                    showLocationInTreeItemDescription: groupBy === 'resourceType' && hasDuplicateSiteName,
+                });
             }
 
             return undefined;
@@ -121,4 +144,9 @@ export class FunctionAppResolver implements AppResourceResolver {
             && !!resource.kind?.includes('functionapp')
             && !resource.kind?.includes('workflowapp'); // exclude logic apps
     }
+
+    private countSiteName(siteName: string): void {
+        const count: number = (this.siteNameCounter.get(siteName) ?? 0) + 1;
+        this.siteNameCounter.set(siteName, count);
+    }
 }
diff --git a/src/commands/createFunctionApp/FunctionAppCreateStep.ts b/src/commands/createFunctionApp/FunctionAppCreateStep.ts
@@ -168,7 +168,7 @@ export class FunctionAppCreateStep extends AzureWizardExecuteStepWithActivityOut
                     name: extensionVersionKey,
                     value: '~' + getMajorVersion(context.version)
                 }],
-                 
+
                 ...Object.entries(stackSettings.appSettingsDictionary).map(([name, value]) => { return { name, value }; }));
         }
 
@@ -238,8 +238,9 @@ export class FunctionAppCreateStep extends AzureWizardExecuteStepWithActivityOut
         const site = context.newFlexSku ?
             await this.getNewFlexSite(context, context.newFlexSku) :
             await this.getNewSite(context, stack);
-        const result = await client.webApps.beginCreateOrUpdateAndWait(rgName, siteName, site);
+        site.autoGeneratedDomainNameLabelScope = context.newSiteDomainNameLabelScope;
 
+        const result = await client.webApps.beginCreateOrUpdateAndWait(rgName, siteName, site);
         if (context.newFlexSku) {
             if (context.storageAccount) {
                 await tryCreateStorageContainer(context, result, context.storageAccount);
diff --git a/src/commands/createFunctionApp/createCreateFunctionAppComponents.ts b/src/commands/createFunctionApp/createCreateFunctionAppComponents.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { AppInsightsCreateStep, AppInsightsListStep, AppKind, AppServicePlanCreateStep, AppServicePlanListStep, CustomLocationListStep, LogAnalyticsCreateStep, SiteNameStep, WebsiteOS, type IAppServiceWizardContext } from "@microsoft/vscode-azext-azureappservice";
+import { AppInsightsCreateStep, AppInsightsListStep, AppKind, AppServicePlanCreateStep, AppServicePlanListStep, CustomLocationListStep, DomainNameLabelScope, LogAnalyticsCreateStep, SiteDomainNameLabelScopeStep, SiteNameStep, WebsiteOS, type IAppServiceWizardContext } from "@microsoft/vscode-azext-azureappservice";
 import { CommonRoleDefinitions, createRoleId, LocationListStep, ResourceGroupCreateStep, ResourceGroupListStep, RoleAssignmentExecuteStep, StorageAccountCreateStep, StorageAccountKind, StorageAccountListStep, StorageAccountPerformance, StorageAccountReplication, type INewStorageAccountDefaults, type Role } from "@microsoft/vscode-azext-azureutils";
 import { type AzureWizardExecuteStep, type AzureWizardPromptStep, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { FuncVersion, latestGAVersion, tryParseFuncVersion } from "../../FuncVersion";
@@ -60,6 +60,21 @@ export async function createCreateFunctionAppComponents(context: ICreateFunction
         wizardContext.telemetry.properties.durableStorageType = wizardContext.durableStorageType;
     }
 
+    // #region SiteNameStep pre-requisites
+    if (!context.advancedCreation) {
+        LocationListStep.addStep(wizardContext, promptSteps);
+    } else {
+        CustomLocationListStep.addStep(wizardContext, promptSteps);
+        promptSteps.push(new ResourceGroupListStep());
+    }
+
+    promptSteps.push(new SiteDomainNameLabelScopeStep());
+    if (!wizardContext.advancedCreation) {
+        wizardContext.newSiteDomainNameLabelScope = DomainNameLabelScope.Tenant;
+        wizardContext.telemetry.properties.siteDomainNameLabelScope = DomainNameLabelScope.Tenant;
+    }
+    // #endregion
+
     promptSteps.push(new SiteNameStep(wizardContext.dockerfilePath ? "containerizedFunctionApp" : "functionApp"));
 
     if (wizardContext.dockerfilePath) {
@@ -74,7 +89,6 @@ export async function createCreateFunctionAppComponents(context: ICreateFunction
     promptSteps.push(new AuthenticationPromptStep());
 
     if (!wizardContext.advancedCreation) {
-        LocationListStep.addStep(wizardContext, promptSteps);
         // if the user is deploying to a container app, do not use a flex consumption plan
         wizardContext.useFlexConsumptionPlan = !wizardContext.dockerfilePath;
         wizardContext.stackFilter = getRootFunctionsWorkerRuntime(wizardContext.language);
@@ -87,7 +101,6 @@ export async function createCreateFunctionAppComponents(context: ICreateFunction
             executeSteps.push(new LogAnalyticsCreateStep());
         }
     } else {
-        promptSteps.push(new ResourceGroupListStep());
         promptSteps.push(new StorageAccountListStep(
             storageAccountCreateOptions,
             {
@@ -153,8 +166,6 @@ async function createFunctionAppWizard(wizardContext: IFunctionAppWizardContext)
     promptSteps.push(new FunctionAppHostingPlanStep(
         getAvailableFunctionAppHostingPlans(wizardContext) /** availablePlans */,
     ));
-    CustomLocationListStep.addStep(wizardContext, promptSteps);
-
     promptSteps.push(new FunctionAppStackStep());
 
     if (wizardContext.advancedCreation) {
diff --git a/src/commands/deploy/deploy.ts b/src/commands/deploy/deploy.ts
@@ -124,6 +124,7 @@ async function deploy(actionContext: IActionContext, arg1: vscode.Uri | string |
     context.telemetry.properties.projectLanguage = language;
     context.telemetry.properties.projectRuntime = version;
     context.telemetry.properties.languageModel = String(languageModel);
+    context.telemetry.properties.siteDomainNameLabelScope = site.rawSite.autoGeneratedDomainNameLabelScope ?? 'Legacy';
 
     if (language === ProjectLanguage.Python && !site.isLinux) {
         context.errorHandling.suppressReportIssue = true;
diff --git a/src/tree/ResolvedFunctionAppResource.ts b/src/tree/ResolvedFunctionAppResource.ts
@@ -29,12 +29,17 @@ export function isResolvedFunctionApp(ti: unknown): ti is ResolvedFunctionAppRes
     return (ti as unknown as ResolvedFunctionAppResource).instance === ResolvedFunctionAppResource.instance;
 }
 
+type ResolvedFunctionAppResourceOptions = {
+    showLocationInTreeItemDescription?: boolean;
+};
+
 export class ResolvedFunctionAppResource extends ResolvedFunctionAppBase implements ResolvedAppResourceBase {
     protected _site: ParsedSite | undefined = undefined;
     declare public data: Site;
     public dataModel: FunctionAppModel;
 
     private _subscription: ISubscriptionContext;
+    private _options: ResolvedFunctionAppResourceOptions;
     public logStreamPath: string = '';
     public appSettingsTreeItem: AppSettingsTreeItem;
     public deploymentsNode: DeploymentsTreeItem | undefined;
@@ -67,9 +72,10 @@ export class ResolvedFunctionAppResource extends ResolvedFunctionAppBase impleme
     tooltip?: string | undefined;
     commandArgs?: unknown[] | undefined;
 
-    public constructor(subscription: ISubscriptionContext, site: Site | undefined, dataModel?: FunctionAppModel) {
+    public constructor(subscription: ISubscriptionContext, site: Site | undefined, dataModel?: FunctionAppModel, options?: ResolvedFunctionAppResourceOptions) {
         super();
         this._subscription = subscription;
+        this._options = options ?? {};
         this.contextValuesToAdd = [];
         if (dataModel) {
             this._isFlex = dataModel.isFlex;
@@ -148,11 +154,18 @@ export class ResolvedFunctionAppResource extends ResolvedFunctionAppBase impleme
     }
 
     public get description(): string | undefined {
-        let state = this._state?.toLowerCase() !== 'running' ? this._state : undefined;
-        if (this._isFlex && !state) {
-            state = localize('flexFunctionAppState', 'Flex Consumption');
+        let description = this._state?.toLowerCase() !== 'running' ? this._state : undefined;
+        if (this._isFlex && !description) {
+            description = localize('flexFunctionAppState', 'Flex Consumption');
+        }
+        if (this._options.showLocationInTreeItemDescription) {
+            if (description) {
+                description += ` (${this.dataModel.location})`;
+            } else {
+                description = this.dataModel.location;
+            }
         }
-        return state;
+        return description;
     }
 
     public get iconPath(): TreeItemIconPath {
@@ -212,7 +225,7 @@ export class ResolvedFunctionAppResource extends ResolvedFunctionAppBase impleme
             let data: any;
             try {
                 await this.initSite(context);
-                 
+
                 data = JSON.parse((await getFile(context, this.site, 'site/wwwroot/host.json')).data);
             } catch {
                 // ignore and use default
@@ -302,7 +315,7 @@ export class ResolvedFunctionAppResource extends ResolvedFunctionAppBase impleme
         return children;
     }
 
-     
+
     public async pickTreeItemImpl(expectedContextValues: (string | RegExp)[]): Promise<AzExtTreeItem | undefined> {
         return await callWithTelemetryAndErrorHandling('functionApp.pickTreeItem', async (context: IActionContext) => {
             await this.initSite(context);
diff --git a/src/tree/containerizedFunctionApp/ResolvedContainerizedFunctionAppResource.ts b/src/tree/containerizedFunctionApp/ResolvedContainerizedFunctionAppResource.ts
diff --git a/src/utils/azureClients.ts b/src/utils/azureClients.ts
