Azure App Service

https://learn.microsoft.com/azure/app-service/
Admin
Azure App Service is a fully managed platform as a service (PaaS) that enables developers to build,...
Tokens:955,112
Snippets:6,171
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### azd up output example

Source: https://learn.microsoft.com/en-us/azure/app-service/quickstart-managed-instance

Example output of the azd up command showing the deployed resource names. These values are used later in the quickstart.

```text
=== Deployment Complete ===
Storage Account: stgpjqep6fdlfv6
Container Name: scripts
Managed Identity Client name: id-gpjqep6fdlfv6
Resource Group: rg-managed-instance
```

--------------------------------

### Quick start with Azure Developer CLI

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-python-postgresql-app-fastapi

Run these commands in an empty working directory to skip to the end of the tutorial. Requires Azure Developer CLI installed.

```bash
azd auth login
azd init --template msdocs-fastapi-postgresql-sample-app
azd up
```

--------------------------------

### Install Hybrid Connection Manager on Linux

Source: https://learn.microsoft.com/en-us/azure/app-service/app-service-hybrid-connections

Run these commands as administrator to download and install the Hybrid Connection Manager on Linux. Requires apt, tar, gzip, and build-essential. The setup script is made executable and run.

```bash
sudo apt update
sudo apt install tar gzip build-essential
sudo wget "https://download.microsoft.com/download/HybridConnectionManager-Linux.tar.gz"
sudo tar -xf HybridConnectionManager-Linux.tar.gz
cd HybridConnectionManager/
sudo chmod 755 setup.sh
sudo ./setup.sh
```

--------------------------------

### Start development server commands

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-ai-integrate-azure-ai-agent-python

Commands to set up a virtual environment, install dependencies, seed data, and run the FastAPI app with uvicorn on port 8000.

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r src/requirements.txt
pip install -e src
python3 src/fastapi_app/seed_data.py
python3 -m uvicorn fastapi_app:app --reload --port=8000
```

--------------------------------

### Restore packages and run the application

Source: https://learn.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-rest-api

Installs the required NuGet packages and starts the ASP.NET Core application. After running, the app is available at http://localhost:5000.

```bash
dotnet restore
dotnet run
```

--------------------------------

### Use a non-Gunicorn server (aiohttp)

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-language-python

Example startup command to use a different web server, such as aiohttp. Use this command as the startup command or in the startup command file.

```bash
python3.7 -m aiohttp.web -H localhost -P 8080 package.module:init_func
```

--------------------------------

### Example package.json start script

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-language-nodejs

To start your app with npm start, ensure a start script is defined in your package.json file. This example shows a start script that runs gulp.

```json
{
  ...
  "scripts": {
    "start": "gulp",
    ...
  },
  ...
}
```

--------------------------------

### Set up virtual environment and install packages

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-ai-openai-chatbot-python

Creates a Python virtual environment, activates it, installs Flask, OpenAI, Azure Identity, and dotenv packages, and freezes the installed packages to requirements.txt.

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install flask openai azure.identity dotenv
pip freeze > requirements.txt
```

--------------------------------

### Run npm install && npm start

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-nodejs-mongodb-app

Run this command in the codespace terminal to install dependencies and start the Express.js application on port 3000.

```bash
npm install && npm start
```

--------------------------------

### Example container start-up logs

Source: https://learn.microsoft.com/en-us/azure/app-service/quickstart-custom-container

Example output from the log stream service showing container start-up progress and success messages.

```text
2018-07-27T12:03:11  Welcome, you are now connected to log-streaming service.
27/07/2018 12:04:10.978 INFO - Site: win-container-demo - Start container succeeded. Container: facbf6cb214de86e58557a6d073396f640bbe2fdec88f8368695c8d1331fc94b
27/07/2018 12:04:16.767 INFO - Site: win-container-demo - Container start complete
27/07/2018 12:05:05.017 INFO - Site: win-container-demo - Container start complete
27/07/2018 12:05:05.020 INFO - Site: win-container-demo - Container started successfully
```

--------------------------------

### GET request to /.auth/logout with post_logout_redirect_uri

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-customize-sign-in-out

Example of a GET request to the logout endpoint with the post_logout_redirect_uri query parameter to change the post-sign-out redirect page. The value should be URL-encoded.

```HTTP
GET /.auth/logout?post_logout_redirect_uri=/index.html
```

--------------------------------

### Example configuration script (PowerShell)

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-managed-instance

PowerShell script that installs a component (e.g., Crystal Reports, Control Library, Database Driver) from the script package. It uses Start-Process with /q for silent install and exits with error if installation fails.

```powershell
# Install Components, for example Crystal Reports, Control Library, Database Driver
$ComponentInstaller = "myInstallerFileNameGoesHere.msi"
try {
    $Component = Join-Path $PSScriptRoot $ComponentInstaller
    Start-Process $Component -ArgumentList "/q" -Wait -ErrorAction Stop
} catch {
    Write-Error "Failed to install ${ComponentInstaller}: $_"
    exit 1
}
```

--------------------------------

### Run the sample app with Maven Jetty

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-java-tomcat-mysql-app

Starts the Jetty server for the sample application. The app becomes available on port 80.

```bash
mvn jetty:run
```

--------------------------------

### Startup script src/entrypoint.sh

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-python-postgresql-app-fastapi

Bash script that App Service runs to start the FastAPI app. It upgrades pip, installs the src package, seeds data, and starts gunicorn with the app's gunicorn configuration.

```bash
#!/bin/bash
set -e
python3 -m pip install --upgrade pip
python3 -m pip install -e src
python3 src/fastapi_app/seed_data.py
python3 -m gunicorn fastapi_app:app -c src/gunicorn.conf.py
```

--------------------------------

### Deploy Flask quickstart with Azure Developer CLI

Source: https://learn.microsoft.com/en-us/azure/app-service/quickstart-python

Commands to create a Flask quickstart directory, initialize the Azure Developer CLI template, and deploy the app to Azure App Service.

```bash
mkdir flask-quickstart
cd flask-quickstart
azd init --template https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
azd up
```

--------------------------------

### Create Azure resources and deploy sample app

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-troubleshoot-monitor

Run these Azure CLI commands to create a resource group, deployment user, App Service plan, web app, and deploy the sample app. You will be prompted for the deployment user password. Replace <username>, <password>, <app-name>, and <url-from-app-webapp-create> with your values.

```bash
az group create --name myResourceGroup --location "South Central US"
az webapp deployment user set --user-name <username> --password <password>
az appservice plan create --name myAppServicePlan --resource-group myResourceGroup --sku B1 --is-linux
az webapp create --resource-group myResourceGroup --plan myAppServicePlan --name <app-name> --runtime "PHP|8.4" --deployment-local-git
az webapp config appsettings set --name <app-name> --resource-group myResourceGroup --settings DEPLOYMENT_BRANCH='main'
git clone https://github.com/Azure-Samples/App-Service-Troubleshoot-Azure-Monitor
cd App-Service-Troubleshoot-Azure-Monitor
git branch -m main
git remote add azure <url-from-app-webapp-create>
git push azure main
```

--------------------------------

### GET request to /.auth/logout with external redirect URL

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-customize-sign-in-out

Example of a GET request to the logout endpoint with a fully qualified external redirect URL. The URL must be hosted in the same domain or configured as an allowed external redirect URL.

```HTTP
GET /.auth/logout?post_logout_redirect_uri=https%3A%2F%2Fmyexternalurl.com
```

--------------------------------

### Set custom command with az webapp config set

Source: https://learn.microsoft.com/en-us/azure/app-service/configure-language-nodejs

Use this Azure CLI command to start your app with a custom command, such as an executable like run.sh. The example runs npm run start:prod. Replace the placeholders with your resource group and app name.

```bash
az webapp config set --resource-group <resource-group-name> --name <app-name> --startup-file "npm run start:prod"
```

--------------------------------

### Deploy Django quickstart with Azure Developer CLI

Source: https://learn.microsoft.com/en-us/azure/app-service/quickstart-python

Commands to create a Django quickstart directory, initialize the Azure Developer CLI template, and deploy the app to Azure App Service.

```bash
mkdir django-quickstart
cd django-quickstart
azd init --template https://github.com/Azure-Samples/msdocs-python-django-webapp-quickstart
azd up
```

--------------------------------

### Navigate into the project directory

Source: https://learn.microsoft.com/en-us/azure/app-service/quickstart-aspire

Change the current directory to the newly created `aspire-starter` project directory.

```bash
cd aspire-starter
```

--------------------------------

### Run the application locally with npm commands

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-ai-agent-web-app-langgraph-foundry-node

Commands to install dependencies, build the project, and start the application. After running, the app is available on port 3000.

```bash
npm install
npm run build
npm start
```

--------------------------------

### azd up output example

Source: https://learn.microsoft.com/en-us/azure/app-service/tutorial-python-postgresql-app-fastapi

Example output from azd up showing subscription, location, resource creation progress, and deployment endpoint.

```text
Subscription: Your subscription name (1111111-1111-1111-1111-111111111111)
Location: East US

  You can view detailed progress in the Azure portal:
  https://portal.azure.com/#view/HubsExtension/DeploymentDetailsBlade/~/overview/id/%2Fsubscriptions%2F1111111-1111-1111-1111-111111111111%2Fproviders%2FMicrosoft.Resources%2Fdeployments%2Fyourenv-1721867673

  (✓) Done: Resource group: yourenv-rg
  (✓) Done: Virtual Network: yourenv-e2najjk4vewf2-vnet
  (✓) Done: App Service plan: yourenv-e2najjk4vewf2-service-plan
  (✓) Done: Log Analytics workspace: yourenv-e2najjk4vewf2-workspace
  (✓) Done: Application Insights: yourenv-e2najjk4vewf2-appinsights
  (✓) Done: Portal dashboard: yourenv-e2najjk4vewf2-dashboard
  (✓) Done: App Service: yourenv-e2najjk4vewf2-app-service
  (✓) Done: Azure Database for PostgreSQL flexible server: yourenv-e2najjk4vewf2-postgres-server
  (✓) Done: Cache for Redis: yourenv-e2najjk4vewf2-redisCache
  (✓) Done: Private Endpoint: cache-privateEndpoint

SUCCESS: Your application was provisioned in Azure in 32 minutes.
You can view the resources created under the resource group yourenv-rg in Azure portal:
https://portal.azure.com/#@/resource/subscriptions/1111111-1111-1111-1111-111111111111/resourceGroups/yourenv-rg/overview

Deploying services (azd deploy)

  (✓) Done: Deploying service web
  - Endpoint: https://yourenv-e2najjk4vewf2-app-service.azurewebsites.net/
```

--------------------------------

### Install .NET connector SDK packages

Source: https://learn.microsoft.com/en-us/azure/app-service/overview-managed-connectors

Adds the Azure.Connectors.Sdk preview package and Azure.Identity to an ASP.NET Core project. Pin the versions when reproducing the examples.

```bash
dotnet add package Azure.Connectors.Sdk --version 0.11.0-preview.1
dotnet add package Azure.Identity --version 1.21.0
```
Tokens:
Raw