Added support for enabling Application Insights for App Service #11998

ShilpiRach · 2025-10-14T05:10:33Z

Description

The changes in this PR is for the following change:

Adding support to enable Application Insights for App Service

Added properties to AzureAppServiceEnvironmentResource to track if App Insights is enabled (default is false) and to track location for provisioning App Insights.
- This is needed because the available regions for Application Insights resource is very different from the available regions for App Service.
Added 3 overloads for WithAzureApplicationInsights
- WithAzureApplicationInsights (string? location)
  - location is optional, if not specified we provision app insights resource in ResourceGroup location
- WithAzureApplicationInsights (IResouceBuilder<ParameterResource>)
  - This is to allow customers to choose App Insights location during deployment.
WithAzureApplicationInsights (IResouceBuilder<AzureApplicationInsightsResource>)
- This is to allow customers to choose an existing App Insights resource.
Also added support WithAzureApplicationInsights for app service
- This allows an app service to disable application insights

Testing

Ran azd up and aspire deploy for the 3 scenarios:

WithAzureApplicationInsights() - Validated that app insights resource is provisioned in the resource group location (only bicep generation).
WithAzureApplicationInsights(location) - Validated that app insights resource is provisioned in the specified location.
WithAzureApplicationInsights(locationParam) - Validated that during deployment, we get prompt for specifying app Insights location and app insights resource is provisioned in the specified location.

WithAzureApplicationInsights(appInsightsResource) - Validated that existing app insights resource is referenced by the app services

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue (consider using one of the following templates):
- No

github-actions · 2025-10-14T05:10:41Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 11998

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 11998"

Copilot

Pull Request Overview

Adds support for enabling Application Insights in Azure App Service environments and surfaces the resulting App Service URL during deployment.

Introduces environment properties and extension methods to enable and configure Application Insights (string or parameter-based location).
Generates Bicep outputs and infrastructure resources (Log Analytics + Application Insights) and adds related app settings.
Updates deployment utilities to construct and print the App Service URL.

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
AzureAppServiceTests.AzureAppServiceEnvironmentCanReferenceExistingAppServicePlan.verified.bicep	Adds unique string output used for App Service hostname construction.
AzureAppServiceTests.AddContainerAppEnvironmentAddsEnvironmentResource.verified.bicep	Same unique string output added for hostname logic.
AzureAppServiceTests.AddAppServiceWithApplicationInsightsLocationParam.verified.json	Adds manifest params including Application Insights location parameter.
AzureAppServiceTests.AddAppServiceWithApplicationInsightsLocationParam.verified.bicep	Generates resources (Web App, Log Analytics, App Insights) using parameter-based location.
AzureAppServiceTests.AddAppServiceWithApplicationInsightsLocation.verified.json	Adds manifest without explicit App Insights param (fixed location).
AzureAppServiceTests.AddAppServiceWithApplicationInsightsLocation.verified.bicep	Generates resources with explicit string location for App Insights.
AzureAppServiceTests.AddAppServiceWithApplicationInsightsDefaultLocation.verified.json	Manifest for default (resource group) location scenario.
AzureAppServiceTests.AddAppServiceWithApplicationInsightsDefaultLocation.verified.bicep	Generates resources with App Insights in resource group location.
AzureAppServiceTests.AddAppServiceEnvironmentWithoutDashboardAddsEnvironmentResource.verified.bicep	Adds unique string output for hostname when dashboard disabled.
AzureAppServiceTests.cs	Adds three new tests covering string, default, and parameter-based App Insights location.
AzureEnvironmentResource.cs	Adds logic to derive and print App Service endpoint URL using unique string output.
AzureAppServiceWebsiteContext.cs	Adds creation of Log Analytics workspace, Application Insights component, and related app settings.
AzureAppServiceEnvironmentResource.cs	Adds properties controlling Application Insights enablement and location configuration.
AzureAppServiceEnvironmentExtensions.cs	Adds two public extension methods to enable Application Insights (string or parameter).
Aspire.Hosting.Azure.AppService.csproj	Adds project reference to Application Insights provisioning assembly.

src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebsiteContext.cs

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs

Copilot · 2025-10-17T20:12:27Z

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs

+    /// <summary>
+    /// Configures whether Azure Application Insights should be enabled for the Azure App Service.
+    /// </summary>
+    /// <param name="builder">The AzureAppServiceEnvironmentResource to configure.</param>
+    /// <param name="applicationInsightsLocation">The location for Application Insights.</param>
+    /// <returns><see cref="IResourceBuilder{T}"/></returns>
+    public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithAzureApplicationInsights(this IResourceBuilder<AzureAppServiceEnvironmentResource> builder, string? applicationInsightsLocation = null)
+    {


These public extension methods lack remarks and usage examples required by the XML documentation standards; add a section explaining default behavior (resource group location when null), precedence between string and parameter overloads, and an showing enabling Application Insights with explicit and parameter-based locations.

Copilot · 2025-10-17T20:12:27Z

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs

+    /// <summary>
+    /// Configures whether Azure Application Insights should be enabled for the Azure App Service.
+    /// </summary>
+    /// <param name="builder">The AzureAppServiceEnvironmentResource to configure.</param>
+    /// <param name="applicationInsightsLocation">The location parameter for Application Insights.</param>
+    /// <returns><see cref="IResourceBuilder{T}"/></returns>
+    public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithAzureApplicationInsights(this IResourceBuilder<AzureAppServiceEnvironmentResource> builder, IResourceBuilder<ParameterResource> applicationInsightsLocation)
+    {


These public extension methods lack remarks and usage examples required by the XML documentation standards; add a section explaining default behavior (resource group location when null), precedence between string and parameter overloads, and an showing enabling Application Insights with explicit and parameter-based locations.

tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs

Copilot · 2025-10-17T20:12:28Z

tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs

+
+        await ExecuteBeforeStartHooksAsync(app, default);
+
+        var model = app.Services.GetRequiredService<DistributedApplicationModel>();


The variable model is retrieved but never used in these three test methods; remove the unused assignments to keep tests concise.

tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs

…Resource.cs Co-authored-by: Copilot <[email protected]>

Co-authored-by: Copilot <[email protected]>

…Resource.cs Co-authored-by: Copilot <[email protected]>

Co-authored-by: Copilot <[email protected]>

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs

davidfowl · 2025-10-17T21:39:55Z

You need to be able to customize this.

…pire into appsvc_appinsights

src/Aspire.Hosting.Azure.AppService/AzureAppServiceComputeResourceExtensions.cs

ShilpiRach · 2025-10-24T12:39:10Z

You need to be able to customize this.

Added support for that using ConfigureInfrastructure - AppInsights is now provisioned as an infra resource

src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsReferenceAnnotation.cs

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs

src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebsiteContext.cs

…ceEnvironment

eerhardt · 2025-10-24T19:30:33Z

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

+            var hostName = $"{computeResource.Name.ToLowerInvariant()}.{webSiteSuffix}";
+            if (hostName.Length > 60)
+            {
+                hostName = hostName.Substring(0, 60);
+            }
+            var endpoint = $"https://{hostName}.azurewebsites.net";


2 things here.

This needs a - in between, not a ..

In a follow up, we could use this method.

aspire/src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs

Lines 67 to 71 in d9c3266

ReferenceExpression IComputeEnvironmentResource.GetHostAddressExpression(EndpointReference endpointReference)

{

var resource = endpointReference.Resource;

return ReferenceExpression.Create($"{resource.Name.ToLowerInvariant()}-{WebSiteSuffix}.azurewebsites.net");

}

This scenario is exactly what that method is intended for - given an EndpointReference to a compute resource, get its HostAddress for the given environment.

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

Co-authored-by: Eric Erhardt <[email protected]>

eerhardt

LGTM. Thanks!

## Description The changes in this PR is for the following change: #### Adding support to enable Application Insights for App Service - Added properties to AzureAppServiceEnvironmentResource to track if App Insights is enabled (default is false) and to track location for provisioning App Insights. - This is needed because the available regions for Application Insights resource is very different from the available regions for App Service. - Added 3 overloads for `WithAzureApplicationInsights` - `WithAzureApplicationInsights (string? location)` - `location` is optional, if not specified we provision app insights resource in ResourceGroup location - `WithAzureApplicationInsights (IResouceBuilder<ParameterResource>)` - This is to allow customers to choose App Insights location during deployment. - `WithAzureApplicationInsights (IResouceBuilder<AzureApplicationInsightsResource>)` - This is to allow customers to choose an existing App Insights resource. - Also added support WithAzureApplicationInsights for app service - This allows an app service to disable application insights * Enabled Application Insights by default * Build fixes * Added override for App Insights location * Printing app service uri * Added resource parameter for app insights location and tests * Fixed ParameterResource for app insights location * Changed method signatures for enabling app insights * Update src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs Co-authored-by: Copilot <[email protected]> * Update tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs Co-authored-by: Copilot <[email protected]> * Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]> * Update src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs Co-authored-by: Copilot <[email protected]> * Update tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs Co-authored-by: Copilot <[email protected]> * Reverting the change to print app service urls * Moved AI resource to environment * Printing endpoints of compute resources * Added support to add existing application insights * Added tests * Remove support to disable AppInsights at website level * Switched to use ApplicationInsightsResource directly in AzureAppServiceEnvironment * nit fix * Update src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs Co-authored-by: Eric Erhardt <[email protected]> --------- Co-authored-by: Shilpi Rachna <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Eric Erhardt <[email protected]>

Enabled Application Insights by default

7f8662c

github-actions bot added the area-integrations Issues pertaining to Aspire Integrations packages label Oct 14, 2025

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Oct 14, 2025

ShilpiR added 5 commits October 13, 2025 22:17

Build fixes

2e2b47b

Added override for App Insights location

fa25c89

Printing app service uri

6bd506f

Merge from main

3235090

Added resource parameter for app insights location and tests

3203ad1

ShilpiRach changed the title ~~[TESTING] Enabled Application Insights by default~~ [TESTING] Added support for enabling Application Insights for App Service Oct 17, 2025

ShilpiRach changed the title ~~[TESTING] Added support for enabling Application Insights for App Service~~ Added support for enabling Application Insights for App Service Oct 17, 2025

ShilpiRach changed the title ~~Added support for enabling Application Insights for App Service~~ [Testing] Added support for enabling Application Insights for App Service Oct 17, 2025

ShilpiR added 2 commits October 17, 2025 12:17

Fixed ParameterResource for app insights location

96f246c

Changed method signatures for enabling app insights

419f39a

ShilpiRach changed the title ~~[Testing] Added support for enabling Application Insights for App Service~~ Added support for enabling Application Insights for App Service Oct 17, 2025

ShilpiRach marked this pull request as ready for review October 17, 2025 20:11

ShilpiRach requested a review from captainsafia as a code owner October 17, 2025 20:11

Copilot AI review requested due to automatic review settings October 17, 2025 20:11

ShilpiRach requested a review from eerhardt as a code owner October 17, 2025 20:11

Copilot AI reviewed Oct 17, 2025

View reviewed changes

ShilpiRach and others added 5 commits October 17, 2025 13:20

Update src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironment…

f0aaee1

…Resource.cs Co-authored-by: Copilot <[email protected]>

Update tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs

2f01659

Co-authored-by: Copilot <[email protected]>

Apply suggestion from @Copilot

24bdab0

Co-authored-by: Copilot <[email protected]>

Update src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironment…

dfbdefb

…Resource.cs Co-authored-by: Copilot <[email protected]>

Update tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs

e1f8d5a

Co-authored-by: Copilot <[email protected]>

eerhardt reviewed Oct 17, 2025

View reviewed changes

src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs Outdated Show resolved Hide resolved

ShilpiR added 3 commits October 18, 2025 01:20

Reverting the change to print app service urls

be0654c

Merge branch 'appsvc_appinsights' of https://github.com/ShilpiRach/as…

041a31e

…pire into appsvc_appinsights

Merge from main

051e7d5

ShilpiR added 2 commits October 23, 2025 05:05

Moved AI resource to environment

8bb85b7

Printing endpoints of compute resources

44ad82d

davidfowl reviewed Oct 23, 2025

View reviewed changes

src/Aspire.Hosting.Azure.AppService/AzureAppServiceComputeResourceExtensions.cs Outdated Show resolved Hide resolved

ShilpiR added 2 commits October 24, 2025 05:16

Added support to add existing application insights

461f3f4

Added tests

7e55f50

Remove support to disable AppInsights at website level

6fc6e4e

eerhardt reviewed Oct 24, 2025

View reviewed changes

ShilpiR added 2 commits October 24, 2025 10:59

Switched to use ApplicationInsightsResource directly in AzureAppServi…

629e368

…ceEnvironment

nit fix

02877e3

eerhardt reviewed Oct 24, 2025

View reviewed changes

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs Outdated Show resolved Hide resolved

Update src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

5436987

Co-authored-by: Eric Erhardt <[email protected]>

eerhardt approved these changes Oct 24, 2025

View reviewed changes

eerhardt enabled auto-merge (squash) October 24, 2025 19:32

eerhardt merged commit 9ff11a5 into dotnet:main Oct 24, 2025
895 of 901 checks passed

dotnet-policy-service bot added this to the 13.0 milestone Oct 24, 2025

github-actions bot locked and limited conversation to collaborators Nov 24, 2025


		await ExecuteBeforeStartHooksAsync(app, default);

		var model = app.Services.GetRequiredService<DistributedApplicationModel>();

	ReferenceExpression IComputeEnvironmentResource.GetHostAddressExpression(EndpointReference endpointReference)
	{
	var resource = endpointReference.Resource;
	return ReferenceExpression.Create($"{resource.Name.ToLowerInvariant()}-{WebSiteSuffix}.azurewebsites.net");
	}

Added support for enabling Application Insights for App Service #11998

Added support for enabling Application Insights for App Service #11998

Uh oh!

Conversation

ShilpiRach commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Adding support to enable Application Insights for App Service

Testing

Checklist

Uh oh!

github-actions bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidfowl commented Oct 17, 2025

Uh oh!

Uh oh!

ShilpiRach commented Oct 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eerhardt Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eerhardt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ShilpiRach commented Oct 14, 2025 •

edited

Loading

github-actions bot commented Oct 14, 2025 •

edited

Loading