Add support for domain name label scopes #2703
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| ## Domain Label Scope | ||
|
|
||
| The files in this folder are intended to be temporary because the App Service SDK does not currently support the required API version we need. Consequently, we needed to implement a custom call with custom types. In the future, we expect to be able to remove this folder and consolidate everything into a single web app creation file. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { type NameValuePair, type SiteConfig, type WebSiteManagementClient } from '@azure/arm-appservice'; | ||
| import { createHttpHeaders, createPipelineRequest } from '@azure/core-rest-pipeline'; | ||
| import { createWebSiteClient, WebsiteOS, type CustomLocation } from '@microsoft/vscode-azext-azureappservice'; | ||
| import { createGenericClient, LocationListStep, type AzExtPipelineResponse, type AzExtRequestPrepareOptions } from '@microsoft/vscode-azext-azureutils'; | ||
| import { AzureWizardExecuteStep } from '@microsoft/vscode-azext-utils'; | ||
| import { type AppResource } from '@microsoft/vscode-azext-utils/hostapi'; | ||
| import { type Progress } from 'vscode'; | ||
| import * as constants from '../../../constants'; | ||
| import { ext } from '../../../extensionVariables'; | ||
| import { localize } from '../../../localize'; | ||
| import { nonNullProp } from '../../../utils/nonNull'; | ||
| import { type FullJavaStack, type FullWebAppStack, type IWebAppWizardContext } from '../IWebAppWizardContext'; | ||
| import { getJavaLinuxRuntime } from '../stacks/getJavaLinuxRuntime'; | ||
| import { type WebAppStackValue, type WindowsJavaContainerSettings } from '../stacks/models/WebAppStackModel'; | ||
| import { type SitePayload } from './types'; | ||
|
|
||
| export class WebAppWithDomainLabelScopeCreateStep extends AzureWizardExecuteStep<IWebAppWizardContext> { | ||
| public priority: number = 140; | ||
|
|
||
| public async execute(context: IWebAppWizardContext, progress: Progress<{ message?: string; increment?: number }>): Promise<void> { | ||
|
There was a problem hiding this comment. Most of this file is a straight carryover of the |
||
| context.telemetry.properties.newSiteOS = context.newSiteOS; | ||
| context.telemetry.properties.newSiteStack = context.newSiteStack?.stack.value; | ||
| context.telemetry.properties.newSiteMajorVersion = context.newSiteStack?.majorVersion.value; | ||
| context.telemetry.properties.newSiteMinorVersion = context.newSiteStack?.minorVersion.value; | ||
| if (context.newSiteJavaStack) { | ||
| context.telemetry.properties.newSiteJavaStack = context.newSiteJavaStack.stack.value; | ||
| context.telemetry.properties.newSiteJavaMajorVersion = context.newSiteJavaStack.majorVersion.value; | ||
| context.telemetry.properties.newSiteJavaMinorVersion = context.newSiteJavaStack.minorVersion.value; | ||
| } | ||
| context.telemetry.properties.planSkuTier = context.plan && context.plan.sku && context.plan.sku.tier; | ||
|
|
||
| const message: string = localize('creatingNewApp', 'Creating new web app "{0}"...', context.newSiteName); | ||
| ext.outputChannel.appendLog(message); | ||
| progress.report({ message }); | ||
|
|
||
| const siteName: string = nonNullProp(context, 'newSiteName'); | ||
| const rgName: string = nonNullProp(nonNullProp(context, 'resourceGroup'), 'name'); | ||
|
|
||
| // The SDK does not currently support this updated api version, so we should make the call to the endpoint manually until the SDK gets updated | ||
| const authToken = (await context.credentials.getToken() as { token?: string }).token; | ||
| const options: AzExtRequestPrepareOptions = { | ||
| url: `${context.environment.resourceManagerEndpointUrl}subscriptions/${context.subscriptionId}/resourceGroups/${rgName}/providers/Microsoft.Web/sites/${siteName}?api-version=2024-04-01`, | ||
| method: 'PUT', | ||
| headers: createHttpHeaders({ | ||
| 'Content-Type': 'application/json', | ||
| 'Authorization': `Bearer ${authToken}`, | ||
| }), | ||
| body: JSON.stringify(await this.getNewSite(context)), | ||
| }; | ||
|
|
||
| const client = await createGenericClient(context, undefined); | ||
| // We don't care about storing the response here because the manual response returned is different from the SDK formatting that our code expects. | ||
| // The stored site should come from the SDK instead. | ||
| await client.sendRequest(createPipelineRequest(options)) as AzExtPipelineResponse; | ||
|
|
||
| const sdkClient: WebSiteManagementClient = await createWebSiteClient(context); | ||
| context.site = await sdkClient.webApps.get(rgName, siteName); | ||
| context.activityResult = context.site as AppResource; | ||
| } | ||
|
|
||
| public shouldExecute(context: IWebAppWizardContext): boolean { | ||
| return !context.site; | ||
| } | ||
|
|
||
| private async getNewSite(context: IWebAppWizardContext): Promise<SitePayload> { | ||
| const location = await LocationListStep.getLocation(context, constants.webProvider); | ||
| const newSiteConfig: SiteConfig = this.getSiteConfig(context); | ||
|
|
||
| const site: SitePayload = { | ||
| name: context.newSiteName, | ||
| kind: this.getKind(context), | ||
| location: nonNullProp(location, 'name'), | ||
| properties: { | ||
| autoGeneratedDomainNameLabelScope: context.newSiteDomainNameLabelScope, | ||
| clientAffinityEnabled: true, | ||
| serverFarmId: context.plan && context.plan.id, | ||
| reserved: context.newSiteOS === WebsiteOS.linux, // The secret property - must be set to true to make it a Linux plan. Confirmed by the team who owns this API. | ||
| siteConfig: newSiteConfig, | ||
| }, | ||
| }; | ||
|
|
||
| if (context.customLocation) { | ||
| this.addCustomLocationProperties(site, context.customLocation); | ||
| } | ||
|
|
||
| return site; | ||
| } | ||
|
|
||
| private getKind(context: IWebAppWizardContext): string { | ||
| let kind: string = context.newSiteKind; | ||
| if (context.newSiteOS === 'linux') { | ||
| kind += ',linux'; | ||
| } | ||
| if (context.customLocation) { | ||
| kind += ',kubernetes'; | ||
| } | ||
| return kind; | ||
| } | ||
|
|
||
| private addCustomLocationProperties(site: SitePayload, customLocation: CustomLocation): void { | ||
| site.extendedLocation = { name: customLocation.id, type: 'customLocation' }; | ||
| } | ||
|
|
||
| private getSiteConfig(context: IWebAppWizardContext): SiteConfig { | ||
| const newSiteConfig: SiteConfig = {}; | ||
|
|
||
| newSiteConfig.appSettings = this.getAppSettings(context); | ||
|
|
||
| const stack: FullWebAppStack = nonNullProp(context, 'newSiteStack'); | ||
| if (context.newSiteOS === WebsiteOS.linux) { | ||
| newSiteConfig.linuxFxVersion = stack.stack.value === 'java' ? | ||
| getJavaLinuxRuntime(stack.majorVersion.value, nonNullProp(context, 'newSiteJavaStack').minorVersion) : | ||
| nonNullProp(stack.minorVersion.stackSettings, 'linuxRuntimeSettings').runtimeVersion; | ||
| } else { | ||
| const runtimeVersion: string = nonNullProp(stack.minorVersion.stackSettings, 'windowsRuntimeSettings').runtimeVersion; | ||
| switch (stack.stack.value) { | ||
| case 'dotnet': | ||
| if (!/core/i.test(stack.minorVersion.displayText)) { // Filter out .NET _Core_ stacks because this is a .NET _Framework_ property | ||
| newSiteConfig.netFrameworkVersion = runtimeVersion; | ||
| } | ||
| break; | ||
| case 'php': | ||
| newSiteConfig.phpVersion = runtimeVersion; | ||
| break; | ||
| case 'node': | ||
| newSiteConfig.nodeVersion = runtimeVersion; | ||
| newSiteConfig.appSettings.push({ | ||
| name: 'WEBSITE_NODE_DEFAULT_VERSION', | ||
| value: runtimeVersion | ||
| }); | ||
| break; | ||
| case 'java': | ||
| newSiteConfig.javaVersion = runtimeVersion; | ||
| const javaStack: FullJavaStack = nonNullProp(context, 'newSiteJavaStack'); | ||
| const windowsStackSettings: WindowsJavaContainerSettings = nonNullProp(javaStack.minorVersion.stackSettings, 'windowsContainerSettings'); | ||
| newSiteConfig.javaContainer = windowsStackSettings.javaContainer; | ||
| newSiteConfig.javaContainerVersion = windowsStackSettings.javaContainerVersion; | ||
| break; | ||
| case 'python': | ||
| newSiteConfig.pythonVersion = runtimeVersion; | ||
| break; | ||
| default: | ||
| } | ||
| } | ||
| return newSiteConfig; | ||
| } | ||
|
|
||
| private getAppSettings(context: IWebAppWizardContext): NameValuePair[] { | ||
| const appSettings: NameValuePair[] = []; | ||
| const disabled: string = 'disabled'; | ||
| const trueString: string = 'true'; | ||
|
|
||
| const runtime: WebAppStackValue = nonNullProp(context, 'newSiteStack').stack.value; | ||
| if (context.newSiteOS === WebsiteOS.linux && (runtime === 'node' || runtime === 'python')) { | ||
| appSettings.push({ | ||
| name: 'SCM_DO_BUILD_DURING_DEPLOYMENT', | ||
| value: trueString | ||
| }); | ||
| } | ||
| if (context.appInsightsComponent) { | ||
| appSettings.push({ | ||
| name: 'APPLICATIONINSIGHTS_CONNECTION_STRING', | ||
| value: context.appInsightsComponent.connectionString | ||
| }); | ||
|
|
||
| appSettings.push({ | ||
| name: 'ApplicationInsightsAgent_EXTENSION_VERSION', | ||
| value: context.newSiteOS === WebsiteOS.windows ? '~2' : '~3' // ~2 is for Windows, ~3 is for Linux | ||
| }); | ||
|
|
||
| // all these settings are set on the portal if AI is enabled for Windows apps | ||
| if (context.newSiteOS === WebsiteOS.windows) { | ||
| appSettings.push( | ||
| { | ||
| name: 'APPINSIGHTS_PROFILERFEATURE_VERSION', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'APPINSIGHTS_SNAPSHOTFEATURE_VERSION', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'DiagnosticServices_EXTENSION_VERSION', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'InstrumentationEngine_EXTENSION_VERSION', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'SnapshotDebugger_EXTENSION_VERSION', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'XDT_MicrosoftApplicationInsights_BaseExtensions', | ||
| value: disabled | ||
| }, | ||
| { | ||
| name: 'XDT_MicrosoftApplicationInsights_Mode', | ||
| value: 'default' | ||
| }); | ||
| } else { | ||
| appSettings.push({ | ||
| name: 'APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED', | ||
| value: trueString | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| return appSettings; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adds a lookahead that checks for duplicate site names and adds a location description in order to help differentiate them, example: