Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

tutorial-containerize-deploy-python-web-app-azure-04.md

Latest commit

 

History

History
382 lines (281 loc) · 20.7 KB

tutorial-containerize-deploy-python-web-app-azure-04.md

File metadata and controls

382 lines (281 loc) · 20.7 KB
title Deploy a Python web app container to Azure App Service
description How to deploy a Python web app container (Django or Flask) to App Service using managed identity authentication with Azure Container Registry.
ms.devlang python
ms.topic tutorial
ms.date 04/10/2025
ms.custom devx-track-python, devx-track-azurecli, py-fresh-zinc

Deploy a containerized Python app to App Service

In this part of the tutorial series, you learn how to deploy a containerized Python web application to Azure App Service using the App Service Web App for Containers. This service lets you focus on building and managing your containers without the complexity of maintaining a container orchestrator. With App Service, you can run containerized web apps and streamline deployment using continuous integration/continuous deployment (CI/CD) with Docker Hub, Azure Container Registry, and Visual Studio Team Services. This article is part 4 of a 5-part tutorial series.

By the end of this article, you'll have a fully deployed App Service website running on a Docker container image. App Service uses managed identity to authenticate with Azure Container Registry and retrieve the initial image.

This service diagram highlights the components covered in this article.

:::image type="content" source="./media/tutorial-container-web-app/containerization-of-python-apps-deploy.png" alt-text="A screenshot of the services using in the Tutorial - Containerized Python App on Azure with deployment path highlighted." lightbox="./media/tutorial-container-web-app/containerization-of-python-apps-deploy.png" :::

Azure CLI

Create the web app

Azure CLI commands can be run in the Azure Cloud Shell or on a workstation with the Azure CLI installed.

Important

We recommend using Cloud Shell for all CLI based operations in this tutorial because:

  • Cloud Shell comes pre-authenticated with Azure, eliminating potential login issues
  • All required Azure CLI extensions are pre-installed
  • It provides consistent behavior regardless of local environment differences
  • There's no need to worry about Docker Desktop or local networking issues
  • Cloud Shell has direct connectivity to Azure services, which can help avoid firewall or network configuration problems

  1. Get the resource ID of the group containing Azure Container Registry with the az group show command.

    #!/bin/bash
# Use the same resource group name as in part 2 of this tutorial series.
RESOURCE_GROUP_NAME='msdocs-web-app-rg'

RESOURCE_ID=$(az group show \
  --resource-group $RESOURCE_GROUP_NAME \
  --query id \
  --output tsv)
echo $RESOURCE_ID

    # PowerShell syntax
# Use the same resource group name as in part 2 of this tutorial series.
$RESOURCE_GROUP_NAME='msdocs-web-app-rg'

$RESOURCE_ID=$(az group show `
  --resource-group $RESOURCE_GROUP_NAME `
  --query id `
  --output tsv)
echo $RESOURCE_ID

    RESOURCE_GROUP_NAME should still be set in your environment to the resource group name you used in parts 2 and 3 of this tutorial series. Build container in Azure of this tutorial. If it isn't, uncomment the first line and set it to the name you used.

  2. Create an App Service plan with the az appservice plan create command.

    #!/bin/bash
APP_SERVICE_PLAN_NAME='msdocs-web-app-plan'

az appservice plan create \
    --name $APP_SERVICE_PLAN_NAME \
    --resource-group $RESOURCE_GROUP_NAME \
    --sku B1 \
    --is-linux

    # PowerShell syntax
$APP_SERVICE_PLAN_NAME='msdocs-web-app-plan'

az appservice plan create `
    --name $APP_SERVICE_PLAN_NAME `
    --resource-group $RESOURCE_GROUP_NAME `
    --sku B1 `
    --is-linux

  3. Create a web app with the az webapp create command.

    The following command also enables the system-assigned managed identity for the web app and assigns it the AcrPull role on the specified resource--in this case, the resource group that contains the Azure Container Registry. This grants the system-assigned managed identity pull privileges on any Azure Container Registry in the resource group.

    #!/bin/bash
APP_SERVICE_NAME='msdocs-website-name'
# Use the same rregistry name as in part 2 of this tutorial series.
REGISTRY_NAME='msdocscontainerregistryname'
CONTAINER_NAME=$REGISTRY_NAME'.azurecr.io/msdocspythoncontainerwebapp:latest'

az webapp create \
  --resource-group $RESOURCE_GROUP_NAME \
  --plan $APP_SERVICE_PLAN_NAME \
  --name $APP_SERVICE_NAME \
  --assign-identity '[system]' \
  --scope $RESOURCE_ID \
  --role acrpull \
  --deployment-container-image-name $CONTAINER_NAME 

    # Powershell syntax
$APP_SERVICE_NAME='msdocs-website-name'
# Use the same rregistry name as in part 2 of this tutorial series.
$REGISTRY_NAME='msdocscontainerregistryname'
$CONTAINER_NAME = "$REGISTRY_NAME.azurecr.io/msdocspythoncontainerwebapp:latest"

az webapp create `
  --resource-group $RESOURCE_GROUP_NAME `
  --plan $APP_SERVICE_PLAN_NAME `
  --name $APP_SERVICE_NAME `
  --assign-identity '[system]' `
  --scope $RESOURCE_ID `
  --role acrpull `
  --deployment-container-image-name $CONTAINER_NAME

    Where:

    • APP_SERVICE_NAME must be globally unique as it becomes the website name in the URL https://<website-name>.azurewebsites.net.
    • CONTAINER_NAME is of the form "yourregistryname.azurecr.io/repo_name:tag".
    • REGISTRY_NAME should still be set in your environment to the registry name you used in part 3. Build container in Azure of this tutorial. If necessary, uncomment the line where it's set in the code snippet and set it to the name you used.

    [!NOTE] You may see an error similar to the following output when running the previous command:

    No credential was provided to access Azure Container Registry. Trying to look up...
Retrieving credentials failed with an exception:'No resource or more than one were found with name ...'

    This error arises from the web app's default attempt to use Azure Container Registry admin credentials, which are disabled. It's safe to disregard this error, as the subsequent command configures the web app to use system-assigned managed identity for authentication.

Configure managed identity and webhook

  1. Configure the web app to use managed identities to pull from the Azure Container Registry with the az webapp config set command.

    #!/bin/bash
az webapp config set \
  --resource-group $RESOURCE_GROUP_NAME \
  --name $APP_SERVICE_NAME \
  --generic-configurations '{"acrUseManagedIdentityCreds": true}'

    # PowerShell syntax
az webapp config set `
  --resource-group $RESOURCE_GROUP_NAME `
  --name $APP_SERVICE_NAME `
  --generic-configurations "{\""acrUseManagedIdentityCreds\"": true}"

    Because you enabled the system-assigned managed identity when you created the web app, the managed identity is used to pull from the Azure Container Registry.

  2. Get the application scope credential with the az webapp deployment list-publishing-credentials command.

    #!/bin/bash
CREDENTIAL=$(az webapp deployment list-publishing-credentials \
  --resource-group $RESOURCE_GROUP_NAME \
  --name $APP_SERVICE_NAME \
  --query publishingPassword \
  --output tsv)
echo $CREDENTIAL 

    # PowerShell syntax
$CREDENTIAL=$(az webapp deployment list-publishing-credentials `
  --resource-group $RESOURCE_GROUP_NAME `
  --name $APP_SERVICE_NAME `
  --query publishingPassword `
  --output tsv)
echo $CREDENTIAL

  3. Use the application scope credential to create a webhook with the az acr webhook create command.

    #!/bin/bash
SERVICE_URI='https://$'$APP_SERVICE_NAME':'$CREDENTIAL'@'$APP_SERVICE_NAME'.scm.azurewebsites.net/api/registry/webhook'

az acr webhook create \
  --name webhookforwebapp \
  --registry $REGISTRY_NAME \
  --scope msdocspythoncontainerwebapp:* \
  --uri $SERVICE_URI \
  --actions push 

    # PowerShell syntax
$SERVICE_URI = "https://${APP_SERVICE_NAME}:${CREDENTIAL}@${APP_SERVICE_NAME}.scm.azurewebsites.net/api/registry/webhook"
az acr webhook create `
  --name webhookforwebapp `
  --registry $REGISTRY_NAME `
  --scope msdocspythoncontainerwebapp:* `
  --uri $SERVICE_URI `
  --actions push

    By default, this command creates the webhook in the same resource group and location as the specified Azure Container registry. If desired, you can use the --resource-group and --location parameters to override this behavior.

During the deploy with VS Code, a webhook is created that enables the web app to pull new images from the Azure Container Registry.

Important

Review the webhooks configuration in the Azure Portal to confirm the Service URI ends with "/api/registry/webhook". To review the service URI, open your resource group in the Azure Portal and then open the webhookforwebapp webhook. Click Configure and then review the Service URI. The URI should look like this: https://<app-service-name>:<credential>@<app-service-name>.scm.azurewebsites.net/api/registry/webhook. If the URI doesn't end with "/api/registry/webhook", you need to delete the webhook and create a new one. To delete the webhook, use the az acr webhook delete command.

:::image type="content" source="./media/tutorial-container-web-app/visual-studio-create-app-webhook.png" lightbox="./media/tutorial-container-web-app/visual-studio-create-app-webhook.png" alt-text="A screenshot showing how to check a webhook configuration." :::

Configure connection to MongoDB

In this step, you specify environment variables needed to connect to MongoDB.

To set environment variables in App Service, you create app settings with the following az webapp config appsettings set command.

#!/bin/bash
MONGO_CONNECTION_STRING='your Mongo DB connection string in single quotes'
MONGO_DB_NAME=restaurants_reviews
MONGO_COLLECTION_NAME=restaurants_reviews

az webapp config appsettings set \
   --resource-group $RESOURCE_GROUP_NAME \
   --name $APP_SERVICE_NAME \
   --settings CONNECTION_STRING=$MONGO_CONNECTION_STRING \
        DB_NAME=$MONGO_DB_NAME  \
        COLLECTION_NAME=$MONGO_COLLECTION_NAME \
        SECRET_KEY='supersecretkeythatispassedtopythonapp'

# PowerShell syntax
# Create a settings.json file with all the app settings (avoids string parsing issues with PowerShell with `&` characters)
$Settings = @{
    "CONNECTION_STRING" = "your Mongo DB connection string in double quotes"
    "DB_NAME" = "restaurants_reviews"
    "COLLECTION_NAME" = "restaurants_reviews"
    "SECRET_KEY" = "supersecretkeythatispassedtopythonapp"
}

# Convert to JSON and save to file
$Settings | ConvertTo-Json -Depth 10 | Out-File -FilePath ".\appsettings.json" -Encoding utf8

# Use the JSON file with the az command
Write-Host "Setting app settings from JSON file..."
az webapp config appsettings set `
    --resource-group $RESOURCE_GROUP_NAME `
    --name $APP_SERVICE_NAME `
    --settings "@appsettings.json"
Write-Host "App settings configured successfully!"

# Clean up
Remove-Item -Path ".\appsettings.json"
  • CONNECTION_STRING: A connection string that starts with "mongodb://".
  • DB_NAME: Use "restaurants_reviews".
  • COLLECTION_NAME: Use "restaurants_reviews".

Browse the site

To verify the site is running, go to https://<website-name>.azurewebsites.net; where website name is your app service name. If successful, you should see the restaurant review sample app. It can take a few moments for the site to start the first time. When the site appears, add a restaurant and a review for that restaurant to confirm the sample app is functioning.

If you're running the Azure CLI locally, you can use the az webapp browse command to browse to the web site. If you're using Cloud Shell, open a browser window and navigate to the website URL.

az webapp browse --name $APP_SERVICE_NAME --resource-group $RESOURCE_GROUP_NAME

Note

The az webapp browse command isn't supported in Cloud Shell. Open a browser window and navigate to the website URL instead.

VS Code

Create the web app

These steps require the Docker extension for VS Code.

  1. Refresh the Azure Container Registry in the Docker extension.

    Confirm that the container you built appears under the REGISTRIES section of the Docker extension. If it doesn't, right-click the registry name and select Refresh.

    :::image type="content" source="./media/tutorial-container-web-app/visual-studio-code-refresh-registries.png" lightbox="./media/tutorial-container-web-app/visual-studio-code-refresh-registries.png" alt-text="A screenshot showing how to fresh registries in the Docker extension for Visual Studio Code." :::

  2. Select F1 or CTRL+SHIFT+P to open the command palette, type "Docker Registries", and select the Docker Registries: Deploy Image to Azure App Service... task.

  3. Enter the following values as prompted to deploy the image:

    • Select registry provider: "Azure"
    • Subscription: Select the subscription that contains the Azure Container Registry you created earlier.
    • Select registry: Enter the name of the registry you created earlier in this tutorial.
    • Select repository: Enter the repository name "msdocspythoncontainerwebapp". If you don't see this repo, refresh the Docker extension REGISTRIES section.
    • Select tag: "latest" for the image tag.
    • Enter a globally unique name for the web app: Enter a name that is globally unique to Azure App Service. For example, if you use "msdocs-python-container-web-app", the web app URL would be http://msdocs-python-container-web-app.azurewebsites.net.
    • Select a resource group: Use the resource group that contains the Azure Container Registry you created earlier.
    • Select a Linux App Service plan: Use an existing or create a new one.

  4. View the OUTPUT window for details of the deployment. One of the output lines is "Granting permission for App Service to pull image from ACR...", which the App Service accesses the registry using managed identity.

    :::image type="content" source="./media/tutorial-container-web-app/visual-studio-code-site-deployed.png" lightbox="./media/tutorial-container-web-app/visual-studio-code-site-deployed.png" alt-text="A screenshot showing prompt when Docker image is deployed App Service in Visual Studio Code." :::

    The final site https://<app-name>.azurewebsites.net isn't ready yet because you need to specify MongoDB info.

    When you deploy with Visual Studio Code, managed identity is already set for the App Service to pull images from the registry. You can confirm managed identity is enabled by viewing logs in the OUTPUT window and looking for the message "Granting permission for App Service to pull image from ACR...".

Configure managed identity and webhook

During the deploy with VS Code, a webhook is created that enables the web app to pull new images from the Azure Container Registry.

Important

Review the webhooks configuration in the Azure Portal to confirm the Service URI ends with "/api/registry/webhook". To review the service URI, open the Docker extension in VS Code and find the registry you created. Right-click the registry and select Open in Portal. The registry opens in the Azure portal. Select Webhooks on the service menu of the registry.

:::image type="content" source="./media/tutorial-container-web-app/visual-studio-create-app-webhook.png" lightbox="./media/tutorial-container-web-app/visual-studio-create-app-webhook.png" alt-text="A screenshot showing how to check a webhook configuration." :::

Configure connection to MongoDB

In this step, you specify environment variables needed to connect to MongoDB.

You need the MongoDB connection string for the next steps.

To configure environment variables for the web app from VS Code, you must have the Azure Tools extension pack installed and be signed into Azure from VS Code.

  1. In the Azure Tools extension for Visual Studio Code:

    1. Expand RESOURCES and find App Services under your subscription. (Make sure you viewing resources by Group by Resource Type.)

    2. Expand App Services and find the web app you created.

    3. Expand your web app and right-click on Application Settings.

    4. Select Add new setting....

    :::image type="content" source="./media/tutorial-container-web-app/visual-studio-code-create-app-settings.png" lightbox="./media/tutorial-container-web-app/visual-studio-code-create-app-settings.png" alt-text="A screenshot showing how to add a setting to the App Service in VS Code." :::

  2. Each time you add a new setting, a dialog box appears at the top of the VS Code window where you can add the setting name followed by its value. Add the following settings:

    • CONNECTION_STRING: A connection string that starts with "mongodb://".
    • DB_NAME: Use "restaurants_reviews".
    • COLLECTION_NAME: Use "restaurants_reviews".
    • WEBSITES_PORT: Use "8000" for Django and "5000" for Flask. This environment variable specifies the port on which the container is listening.

Browse the site

In the Azure Tools extension for Visual Studio Code:

  1. Expand RESOURCES and find App Services under your subscription. (Make sure you viewing resources by Group by Resource Type.)

  2. Right-click the App Service and select Browse Website.

    :::image type="content" source="./media/tutorial-container-web-app/app-service-vs-code-browse.png" lightbox="./media/tutorial-container-web-app/app-service-vs-code-browse.png" alt-text="A screenshot showing how to browse an App Service in VS Code." :::

Troubleshoot deployment

If you don't see the sample app, try the following steps.

  • With container deployment and App Service, always check the Deployment Center / Logs page in the Azure portal. Confirm that the container was pulled and is running. The initial pull and running of the container can take a few moments.
  • Try to restart the App Service and see if that resolves your issue.
  • If there are programming errors, those errors show up in the application logs. On the Azure portal page for the App Service, select Diagnose and solve problems/Application logs.
  • The sample app relies on a connection to MongoDB. Confirm that the App Service has application settings with the correct connection info.
  • Confirm that managed identity is enabled for the App Service and is used in the Deployment Center. On the Azure portal page for the App Service, go to the App Service Deployment Center resource and confirm that Authentication is set to Managed Identity.
  • Check that the webhook is defined in the Azure Container Registry. The webhook enables the App Service to pull the container image. In particular, check that Service URI ends with "/api/registry/webhook".
  • Different Azure Container Registry skus have different features, including number of webhooks. If you're reusing an existing registry, you could see the message: "Quota exceeded for resource type webhooks for the registry SKU Basic. Learn more about different SKU quotas and upgrade process: https://aka.ms/acr/tiers". If you see this message, use a new registry, or reduce the number of registry webhooks in use.

Next step

[!div class="nextstepaction"] Clean up resources