Add managed environments to command contexts in preparation for managed identity work (#724)

Author: MicroFish91

src/commands/ManagedEnvironmentContext.ts

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { type ManagedEnvironment } from "@azure/arm-appcontainers";
+import { type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
+import { type AzureSubscription } from "@microsoft/vscode-azureresources-api";
+
+export interface ManagedEnvironmentRequiredContext extends ISubscriptionActionContext {
+    subscription: AzureSubscription;
+    managedEnvironment: ManagedEnvironment;
+}

…ontainerApp/CreateContainerAppContext.ts …ontainerApp/ContainerAppCreateContext.tssrc/commands/createContainerApp/CreateContainerAppContext.ts renamed to src/commands/createContainerApp/ContainerAppCreateContext.ts src/commands/createContainerApp/CreateContainerAppContext.ts renamed to src/commands/createContainerApp/ContainerAppCreateContext.ts

@@ -3,7 +3,6 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { type ManagedEnvironment } from '@azure/arm-appcontainers';
 import { type IResourceGroupWizardContext } from '@microsoft/vscode-azext-azureutils';
 import { type ExecuteActivityContext } from '@microsoft/vscode-azext-utils';
 import { type SetTelemetryProps } from '../../telemetry/SetTelemetryProps';
@@ -12,11 +11,8 @@ import { type IContainerAppContext } from '../IContainerAppContext';
 import { type ImageSourceBaseContext } from '../image/imageSource/ImageSourceContext';
 import { type IngressBaseContext } from '../ingress/IngressContext';
 
-export interface CreateContainerAppBaseContext extends IResourceGroupWizardContext, ImageSourceBaseContext, IngressBaseContext, IContainerAppContext, ExecuteActivityContext {
+export interface ContainerAppCreateBaseContext extends IResourceGroupWizardContext, ImageSourceBaseContext, IngressBaseContext, IContainerAppContext, ExecuteActivityContext {
     newContainerAppName?: string;
-
-    managedEnvironmentId?: string;
-    managedEnvironment?: ManagedEnvironment;
 }
 
-export type CreateContainerAppContext = CreateContainerAppBaseContext & SetTelemetryProps<TelemetryProps>;
+export type ContainerAppCreateContext = ContainerAppCreateBaseContext & SetTelemetryProps<TelemetryProps>;

src/commands/createContainerApp/ContainerAppCreateStep.ts

@@ -12,12 +12,12 @@ import { ContainerAppItem } from "../../tree/ContainerAppItem";
 import { createContainerAppsAPIClient } from "../../utils/azureClients";
 import { localize } from "../../utils/localize";
 import { getContainerNameForImage } from "../image/imageSource/containerRegistry/getContainerNameForImage";
-import { type CreateContainerAppContext } from "./CreateContainerAppContext";
+import { type ContainerAppCreateContext } from "./ContainerAppCreateContext";
 
-export class ContainerAppCreateStep extends AzureWizardExecuteStep<CreateContainerAppContext> {
+export class ContainerAppCreateStep extends AzureWizardExecuteStep<ContainerAppCreateContext> {
     public priority: number = 620;
 
-    public async execute(context: CreateContainerAppContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+    public async execute(context: ContainerAppCreateContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const appClient: ContainerAppsAPIClient = await createContainerAppsAPIClient(context);
 
         const resourceGroupName: string = nonNullValueAndProp(context.resourceGroup, 'name');
@@ -41,7 +41,7 @@ export class ContainerAppCreateStep extends AzureWizardExecuteStep<CreateContain
 
         context.containerApp = ContainerAppItem.CreateContainerAppModel(await appClient.containerApps.beginCreateOrUpdateAndWait(resourceGroupName, containerAppName, {
             location: (await LocationListStep.getLocation(context, containerAppsWebProvider)).name,
-            managedEnvironmentId: context.managedEnvironmentId || context.managedEnvironment?.id,
+            managedEnvironmentId: context.managedEnvironment?.id,
             configuration: {
                 ingress,
                 secrets: context.secrets,
@@ -60,11 +60,11 @@ export class ContainerAppCreateStep extends AzureWizardExecuteStep<CreateContain
         }));
     }
 
-    public shouldExecute(context: CreateContainerAppContext): boolean {
+    public shouldExecute(context: ContainerAppCreateContext): boolean {
         return !context.containerApp;
     }
 
-    public createSuccessOutput(context: CreateContainerAppContext): ExecuteActivityOutput {
+    public createSuccessOutput(context: ContainerAppCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['containerAppCreateStepSuccessItem', activitySuccessContext]),
@@ -75,7 +75,7 @@ export class ContainerAppCreateStep extends AzureWizardExecuteStep<CreateContain
         };
     }
 
-    public createFailOutput(context: CreateContainerAppContext): ExecuteActivityOutput {
+    public createFailOutput(context: ContainerAppCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericParentTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['containerAppCreateStepFailItem', activityFailContext]),

src/commands/createContainerApp/ContainerAppNameStep.ts

@@ -5,15 +5,15 @@
 
 import { type ContainerAppsAPIClient } from "@azure/arm-appcontainers";
 import { getResourceGroupFromId } from "@microsoft/vscode-azext-azureutils";
-import { AzureWizardPromptStep, nonNullProp, type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
+import { AzureWizardPromptStep, nonNullValueAndProp, type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
 import { createContainerAppsAPIClient } from '../../utils/azureClients';
 import { localize } from "../../utils/localize";
-import { type CreateContainerAppContext } from './CreateContainerAppContext';
+import { type ContainerAppCreateContext } from './ContainerAppCreateContext';
 
-export class ContainerAppNameStep extends AzureWizardPromptStep<CreateContainerAppContext> {
+export class ContainerAppNameStep extends AzureWizardPromptStep<ContainerAppCreateContext> {
     public hideStepCount: boolean = true;
 
-    public async prompt(context: CreateContainerAppContext): Promise<void> {
+    public async prompt(context: ContainerAppCreateContext): Promise<void> {
         const prompt: string = localize('containerAppNamePrompt', 'Enter a container app name.');
         context.newContainerAppName = (await context.ui.showInputBox({
             prompt,
@@ -24,7 +24,7 @@ export class ContainerAppNameStep extends AzureWizardPromptStep<CreateContainerA
         context.valuesToMask.push(context.newContainerAppName);
     }
 
-    public shouldPrompt(context: CreateContainerAppContext): boolean {
+    public shouldPrompt(context: ContainerAppCreateContext): boolean {
         return !context.containerApp && !context.newContainerAppName;
     }
 
@@ -41,8 +41,8 @@ export class ContainerAppNameStep extends AzureWizardPromptStep<CreateContainerA
         return undefined;
     }
 
-    private async validateNameAvailable(context: CreateContainerAppContext, name: string): Promise<string | undefined> {
-        const resourceGroupName: string = getResourceGroupFromId(nonNullProp(context, 'managedEnvironmentId'));
+    private async validateNameAvailable(context: ContainerAppCreateContext, name: string): Promise<string | undefined> {
+        const resourceGroupName: string = getResourceGroupFromId(nonNullValueAndProp(context.managedEnvironment, 'id'));
         if (!await ContainerAppNameStep.isNameAvailable(context, resourceGroupName, name)) {
             return localize('containerAppExists', 'The container app "{0}" already exists in resource group "{1}".', name, resourceGroupName);
         }

src/commands/createContainerApp/createContainerApp.ts

@@ -16,9 +16,9 @@ import { localize } from "../../utils/localize";
 import { pickEnvironment } from "../../utils/pickItem/pickEnvironment";
 import { ImageSourceListStep } from "../image/imageSource/ImageSourceListStep";
 import { IngressPromptStep } from "../ingress/IngressPromptStep";
+import { type ContainerAppCreateContext } from "./ContainerAppCreateContext";
 import { ContainerAppCreateStep } from "./ContainerAppCreateStep";
 import { ContainerAppNameStep } from "./ContainerAppNameStep";
-import { type CreateContainerAppContext } from "./CreateContainerAppContext";
 import { showContainerAppNotification } from "./showContainerAppNotification";
 
 export async function createContainerApp(context: IActionContext, node?: ManagedEnvironmentItem): Promise<ContainerAppItem> {
@@ -29,25 +29,25 @@ export async function createContainerApp(context: IActionContext, node?: Managed
 
     node ??= await pickEnvironment(context);
 
-    const wizardContext: CreateContainerAppContext = {
+    const wizardContext: ContainerAppCreateContext = {
         ...context,
         ...createSubscriptionContext(node.subscription),
         ...await createActivityContext(),
         subscription: node.subscription,
-        managedEnvironmentId: node.managedEnvironment.id,
+        managedEnvironment: node.managedEnvironment,
         alwaysPromptIngress: true
     };
 
     const title: string = localize('createContainerApp', 'Create container app');
 
-    const promptSteps: AzureWizardPromptStep<CreateContainerAppContext>[] = [
+    const promptSteps: AzureWizardPromptStep<ContainerAppCreateContext>[] = [
         new ContainerAppNameStep(),
         new ImageSourceListStep(),
         new IngressPromptStep(),
     ];
 
-    const executeSteps: AzureWizardExecuteStep<CreateContainerAppContext>[] = [
-        getVerifyProvidersStep<CreateContainerAppContext>(),
+    const executeSteps: AzureWizardExecuteStep<ContainerAppCreateContext>[] = [
+        getVerifyProvidersStep<ContainerAppCreateContext>(),
         new ContainerAppCreateStep(),
     ];
 
@@ -62,7 +62,7 @@ export async function createContainerApp(context: IActionContext, node?: Managed
 
     await LocationListStep.setLocation(wizardContext, nonNullProp(node.resource, 'location'));
 
-    const wizard: AzureWizard<CreateContainerAppContext> = new AzureWizard(wizardContext, {
+    const wizard: AzureWizard<ContainerAppCreateContext> = new AzureWizard(wizardContext, {
         title,
         promptSteps,
         executeSteps,

src/commands/createContainerApp/setQuickStartImage.ts

@@ -4,9 +4,9 @@
 *--------------------------------------------------------------------------------------------*/
 
 import { quickStartImageName } from "../../constants";
-import { type CreateContainerAppContext } from "./CreateContainerAppContext";
+import { type ContainerAppCreateContext } from "./ContainerAppCreateContext";
 
-export function setQuickStartImage(context: Partial<CreateContainerAppContext>): void {
+export function setQuickStartImage(context: Partial<ContainerAppCreateContext>): void {
     context.image = quickStartImageName;
     context.enableIngress = true;
     context.enableExternal = true;

src/commands/createManagedEnvironment/LogAnalyticsCreateStep.ts

@@ -9,12 +9,12 @@ import { type Progress } from "vscode";
 import { createOperationalInsightsManagementClient } from "../../utils/azureClients";
 import { localize } from "../../utils/localize";
 import { nonNullProp } from "../../utils/nonNull";
-import { type IManagedEnvironmentContext } from "./IManagedEnvironmentContext";
+import { type ManagedEnvironmentCreateContext } from "./ManagedEnvironmentCreateContext";
 
-export class LogAnalyticsCreateStep extends AzureWizardExecuteStep<IManagedEnvironmentContext> {
+export class LogAnalyticsCreateStep extends AzureWizardExecuteStep<ManagedEnvironmentCreateContext> {
     public priority: number = 220;
 
-    public async execute(context: IManagedEnvironmentContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+    public async execute(context: ManagedEnvironmentCreateContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const opClient = await createOperationalInsightsManagementClient(context);
         const resourceGroup = nonNullProp(context, 'resourceGroup');
         const workspaceName = context.newLogAnalyticsWorkspaceName || nonNullProp(context, 'newManagedEnvironmentName');
@@ -26,11 +26,11 @@ export class LogAnalyticsCreateStep extends AzureWizardExecuteStep<IManagedEnvir
             nonNullProp(resourceGroup, 'name'), workspaceName, { location: (await LocationListStep.getLocation(context)).name });
     }
 
-    public shouldExecute(context: IManagedEnvironmentContext): boolean {
+    public shouldExecute(context: ManagedEnvironmentCreateContext): boolean {
         return !context.logAnalyticsWorkspace;
     }
 
-    public createSuccessOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+    public createSuccessOutput(context: ManagedEnvironmentCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['logAnalyticsCreateStepSuccessItem', activitySuccessContext]),
@@ -41,7 +41,7 @@ export class LogAnalyticsCreateStep extends AzureWizardExecuteStep<IManagedEnvir
         };
     }
 
-    public createFailOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+    public createFailOutput(context: ManagedEnvironmentCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericParentTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['logAnalyticsCreateStepFailItem', activityFailContext]),

src/commands/createManagedEnvironment/LogAnalyticsListStep.ts

@@ -9,19 +9,19 @@ import { AzureWizardPromptStep, type IAzureQuickPickItem } from '@microsoft/vsco
 import { createOperationalInsightsManagementClient } from '../../utils/azureClients';
 import { localize } from '../../utils/localize';
 import { nonNullProp } from '../../utils/nonNull';
-import { type IManagedEnvironmentContext } from './IManagedEnvironmentContext';
+import { type ManagedEnvironmentCreateContext } from './ManagedEnvironmentCreateContext';
 
-export class LogAnalyticsListStep extends AzureWizardPromptStep<IManagedEnvironmentContext> {
-    public async prompt(context: IManagedEnvironmentContext): Promise<void> {
+export class LogAnalyticsListStep extends AzureWizardPromptStep<ManagedEnvironmentCreateContext> {
+    public async prompt(context: ManagedEnvironmentCreateContext): Promise<void> {
         const placeHolder: string = localize('selectLogAnalytics', 'Select Log Analytics workspace. Your Log Analytics workspace will contain all your application logs.');
         context.logAnalyticsWorkspace = (await context.ui.showQuickPick(this.getQuickPicks(context), { placeHolder })).data;
     }
 
-    public shouldPrompt(context: IManagedEnvironmentContext): boolean {
+    public shouldPrompt(context: ManagedEnvironmentCreateContext): boolean {
         return !context.logAnalyticsWorkspace;
     }
 
-    private async getQuickPicks(context: IManagedEnvironmentContext): Promise<IAzureQuickPickItem<Workspace | undefined>[]> {
+    private async getQuickPicks(context: ManagedEnvironmentCreateContext): Promise<IAzureQuickPickItem<Workspace | undefined>[]> {
         const picks: IAzureQuickPickItem<Workspace | undefined>[] = [];
 
         picks.push({

…nvironment/IManagedEnvironmentContext.ts …nment/ManagedEnvironmentCreateContext.tssrc/commands/createManagedEnvironment/IManagedEnvironmentContext.ts renamed to src/commands/createManagedEnvironment/ManagedEnvironmentCreateContext.ts src/commands/createManagedEnvironment/IManagedEnvironmentContext.ts renamed to src/commands/createManagedEnvironment/ManagedEnvironmentCreateContext.ts

@@ -9,13 +9,13 @@ import { type IResourceGroupWizardContext } from '@microsoft/vscode-azext-azureu
 import { type ExecuteActivityContext, type ISubscriptionActionContext } from '@microsoft/vscode-azext-utils';
 import { type AzureSubscription } from "@microsoft/vscode-azureresources-api";
 
-export interface IManagedEnvironmentContext extends ISubscriptionActionContext, IResourceGroupWizardContext, ExecuteActivityContext {
+export interface ManagedEnvironmentCreateContext extends ISubscriptionActionContext, IResourceGroupWizardContext, ExecuteActivityContext {
     subscription: AzureSubscription;
 
     newManagedEnvironmentName?: string;
     newLogAnalyticsWorkspaceName?: string;  // This isn't normally populated by a name step, but we still allow this to be prepopulated
-    logAnalyticsWorkspace?: Workspace;
 
     // created when the wizard is done executing
+    logAnalyticsWorkspace?: Workspace;
     managedEnvironment?: ManagedEnvironment;
 }

src/commands/createManagedEnvironment/ManagedEnvironmentCreateStep.ts

@@ -11,12 +11,12 @@ import { managedEnvironmentsAppProvider } from "../../constants";
 import { createContainerAppsAPIClient, createOperationalInsightsManagementClient } from '../../utils/azureClients';
 import { localize } from "../../utils/localize";
 import { nonNullProp, nonNullValueAndProp } from "../../utils/nonNull";
-import { type IManagedEnvironmentContext } from "./IManagedEnvironmentContext";
+import { type ManagedEnvironmentCreateContext } from "./ManagedEnvironmentCreateContext";
 
-export class ManagedEnvironmentCreateStep extends AzureWizardExecuteStep<IManagedEnvironmentContext> {
+export class ManagedEnvironmentCreateStep extends AzureWizardExecuteStep<ManagedEnvironmentCreateContext> {
     public priority: number = 250;
 
-    public async execute(context: IManagedEnvironmentContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+    public async execute(context: ManagedEnvironmentCreateContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const client: ContainerAppsAPIClient = await createContainerAppsAPIClient(context);
         const opClient = await createOperationalInsightsManagementClient(context);
 
@@ -59,11 +59,11 @@ export class ManagedEnvironmentCreateStep extends AzureWizardExecuteStep<IManage
         }
     }
 
-    public shouldExecute(context: IManagedEnvironmentContext): boolean {
+    public shouldExecute(context: ManagedEnvironmentCreateContext): boolean {
         return !context.managedEnvironment;
     }
 
-    public createSuccessOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+    public createSuccessOutput(context: ManagedEnvironmentCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['managedEnvironmentCreateStepSuccessItem', activitySuccessContext]),
@@ -74,7 +74,7 @@ export class ManagedEnvironmentCreateStep extends AzureWizardExecuteStep<IManage
         };
     }
 
-    public createFailOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+    public createFailOutput(context: ManagedEnvironmentCreateContext): ExecuteActivityOutput {
         return {
             item: new GenericParentTreeItem(undefined, {
                 contextValue: createUniversallyUniqueContextValue(['managedEnvironmentCreateStepFailItem', activityFailContext]),