/azure-prepare

Web API Base Template — REFERENCE ONLY

Default template for REST API workloads on Azure App Service. Use when no specific integration is detected or as the base for recipe composition.

Templates by Runtime

Browse all: Awesome AZD App Service

⚠️ The AZD templates above include Mongo/Cosmos by default. When using as a pure Web API base, strip the database layer before applying a recipe:

• Remove infra/app/db.bicep (or equivalent database module)
• Remove Cosmos/Mongo module references from infra/main.bicep
• Remove Cosmos/Mongo packages from the application source

Then apply the appropriate recipe for your data store.

Project Structure

project-root/
├── azure.yaml              # AZD service config
├── infra/
│   ├── main.bicep           # Main orchestrator
│   ├── main.parameters.json
│   └── app/
│       ├── web.bicep         # App Service + Plan
│       └── web-network.bicep # VNet integration (conditional)
└── src/
    └── api/                  # Application source

App Service Plan Configuration

resource appServicePlan 'Microsoft.Web/serverfarms@2023-12-01' = {
  name: '${name}-plan'
  location: location
  tags: tags
  sku: {
    name: 'B1'              // Dev/test — use P1v3+ for production
  }
  properties: {
    reserved: true           // Required for Linux
  }
}

Health Check Endpoint

CRITICAL: Always include a health check endpoint. App Service uses it for instance monitoring.

Configure in App Service:

properties: {
  siteConfig: {
    healthCheckPath: '/health'
  }
}

Health check by language

C# (ASP.NET Core)

app.MapGet("/health", () => Results.Ok(new { status = "healthy" }));

Node.js (Express)

app.get('/health', (req, res) => {
  res.json({ status: 'healthy' });
});

Python (FastAPI)

@app.get("/health")
async def health():
    return {"status": "healthy"}

Java (Spring Boot)

@GetMapping("/health")
public Map<String, String> health() {
    return Map.of("status", "healthy");
}

Dockerfile Reference

All App Service deployments can use container deployment. Each runtime should include a Dockerfile:

Python (FastAPI)

FROM python:3.12-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
EXPOSE 8000
CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

Node.js

FROM node:20-slim
WORKDIR /app
COPY package*.json ./
RUN npm ci --production
COPY . .
EXPOSE 3000
CMD ["node", "src/index.js"]

App Settings (Managed Identity)

💡 Call mcp_bicep_get_az_resource_type_schema with resource type Microsoft.Web/sites to validate properties before generating this resource.

resource webApp 'Microsoft.Web/sites@2023-12-01' = {
  properties: {
    siteConfig: {
      appSettings: [
        { name: 'WEBSITE_HEALTHCHECK_MAXPINGFAILURES', value: '3' }
        { name: 'SCM_DO_BUILD_DURING_DEPLOYMENT', value: 'true' }
      ]
    }
  }
  identity: {
    type: 'UserAssigned'
    userAssignedIdentities: {
      '${managedIdentity.id}': {}
    }
  }
  tags: {
    'azd-service-name': 'api'
  }
}

⚠️ Without azd-service-name tag, azd deploy fails with: resource not found: unable to find a resource tagged with 'azd-service-name: api'

The tag value must match the services.<name> key in azure.yaml. Use api for Web API services.

Deployment

ENV_NAME="$(basename "$PWD" | tr '[:upper:]' '[:lower:]' | tr ' _' '-')-dev"
azd init -t <template> -e "$ENV_NAME" --no-prompt
azd env set AZURE_LOCATION eastus2
azd up --no-prompt

PowerShell:

$ENV_NAME = "$(Split-Path -Leaf (Get-Location) | ForEach-Object { $_.ToLower() -replace '[ _]','-' })-dev"
azd init -t <template> -e $ENV_NAME --no-prompt
azd env set AZURE_LOCATION eastus2
azd up --no-prompt

References

• App Service overview
• App Service best practices
• Health check