Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 5.36 KB

README.md

File metadata and controls

88 lines (58 loc) · 5.36 KB
Raw
languages page_type products urlFragment name description
csharp
aspx-csharp
bicep
sample
azure
aspnet-core
azure-app-service
azure-sql-database
azure-virtual-network
msdocs-app-service-sqldb-dotnetcore
Deploy an ASP.NET Core web app with SQL Database in Azure
A sample application you can use to follow along with Tutorial: Deploy an ASP.NET Core and Azure SQL Database app to Azure App Service.

Deploy an ASP.NET Core web app with SQL Database in Azure

This is an ASP.NET Core application that you can use to follow along with the tutorial at Tutorial: Deploy an ASP.NET Core and Azure SQL Database app to Azure App Service or by using the Azure Developer CLI (azd) according to the instructions below.

Run the sample

This project has a dev container configuration, which makes it easier to develop apps locally, deploy them to Azure, and monitor them. The easiest way to run this sample application is inside a GitHub codespace. Follow these steps:

  1. Fork this repository to your account. For instructions, see Fork a repo.

  2. From the repository root of your fork, select Code > Codespaces > +.

  3. In the codespace terminal, run the following commands:

    dotnet ef database update
dotnet run

  4. When you see the message Your application running on port 5093 is available., click Open in Browser.

Quick deploy

This project is designed to work well with the Azure Developer CLI, which makes it easier to develop apps locally, deploy them to Azure, and monitor them.

🎥 Watch a deployment of the code in this screencast.

In the GitHub codespace:

  1. Log in to Azure.

    azd auth login

  2. Provision and deploy all the resources:

    azd up

    It will prompt you to create a deployment environment name, pick a subscription, and provide a location (like westeurope). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location (like to "centralus") can help, as there may be availability constraints for some of the resources.

  3. When azd has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the CRUD app! 🎉 If you see an error, open the Azure Portal from the URL in the command output, navigate to the App Service, select Logstream, and check the logs for any errors.

  4. When you've made any changes to the app code, you can just run:

    azd deploy

How is database migrations automated?

The AZD template in this repo secures the database in a virtual network through a private endpoint. The web app can access the database through the private endpoint because it's integrated with the virtual network. In this architecture, the simplest way to do database migrations is directly from within the web app itself.

Because the Linux .NET container in App Service doesn't come with the .NET SDK, you cannot run the migrations command dotnet ef database update easily. However, you can upload a self-contained migrations bundle. This repo automates the deployment of the migrations bundle as follows:

  • In azure.yaml, use the prepackage hook to generate a migrationsbundle file with dotnet ef migrations bundle.
  • In the .csproj file, include the generated migrationsbundle file. During the azd package stage, migrationsbundle will be added to the deploy package.
  • In infra/resources.bicep, add the appCommandLine property to the web app to run the uploaded migrationsbundle.

How does the AZD template configure passwords?

Two types of secrets are involved: the SQL Database administrator password and the access key for Cache for Redis, and they are both present in the respective connection strings. The AZD template in this repo manages both connection strings in a key vault that's secured behind a private endpoint.

To simplify the scenario, the AZD template generates a new database password each time you run azd provision or azd up, and the database connection string in the key vault is modified too. If you want to fully utilize secretOrRandomPassword in the parameter file by committing the automatically generated password to the key vault the first time and reading it on subsequent azd commands, you must relax the networking restriction of the key vault to allow traffic from public networks. For more information, see What is the behavior of the secretOrRandomPassword function?.

Getting help

If you're working with this project and running into issues, please post in Issues.