Add README to Aspire.Hosting.Azure.AppService #12105
Conversation
Co-authored-by: davidfowl <[email protected]>
Copilot
AI
changed the title
|
|
||
| ## Usage example | ||
|
|
||
| In the _Program.cs_ file of your AppHost project, add an Azure App Service Environment and publish your project as an Azure App Service website: |
| builder.AddProject<Projects.MyWebApp>("webapp") | ||
| .PublishAsAzureAppServiceWebsite((infrastructure, site) => | ||
| { | ||
| // Configure the App Service website | ||
| site.SiteConfig.IsWebSocketsEnabled = true; | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
we also need .WithExternalHttpEndpoints() ?
There was a problem hiding this comment.
@copilot address this feedback and describe the constraints of app service:
- Only external endpoints HTTP or HTTPS based endpoints
- Can only have a single endpoint
|
@copilot implement feedback from @sarsharma |
Co-authored-by: mitchdenny <[email protected]>
Updated the README to match the conventions used in other Azure hosting packages. Changes include:
These changes align with the patterns established in Aspire.Hosting.Azure.CosmosDB, Aspire.Hosting.Azure.ApplicationInsights, and other Azure hosting packages. Commit: Will be provided after the changes are pushed. |
|
@copilot Address this feedback and describe the constraints of app service: Only external endpoints HTTP or HTTPS based endpoints. (WithExternaHttpEndpoints) |
Co-authored-by: davidfowl <[email protected]>
Added a dedicated section documenting Azure App Service constraints:
Updated all code examples to include |
|
@copilot src/Aspire.Hosting.Azure.AppService/README.md:19-34 This does not apply since this is a publish time resource only. src/Aspire.Hosting.Azure.AppService/README.md:98 Instead show the WithDashboard extension method @dotnet/aspire/files/src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs |
Co-authored-by: davidfowl <[email protected]>
Removed the "Configure Azure Provisioning for local development" section since this is a publish-time resource only. Updated the dashboard configuration example to use the |
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12105Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12105" |
4 participants
This PR adds a comprehensive README.md file to the
Aspire.Hosting.Azure.AppServicepackage, providing documentation for developers on how to use this package to deploy .NET Aspire applications to Azure App Service.What's included
The README covers:
WithDashboardextension methodWithExternalHttpEndpoints())Pattern consistency
The README follows the conventions used by other Azure hosting packages in the repository, with appropriate adjustments for App Service being a publish-time resource only (no Azure provisioning configuration section included).
All code examples include the required
WithExternalHttpEndpoints()call to properly demonstrate the correct usage pattern for Azure App Service deployments, and use the properWithDashboardextension method for dashboard configuration.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.