如何避免Azure BICEP部署出现间歇性InternalServerError？

问题描述 #

部署大型Azure BICEP脚本时，间歇性收到Azure返回的暂态错误，错误信息如下：

{
  "code": "DeploymentFailed",
  "target": "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/xx-xx-rg-tst-xx-eus-99/providers/Microsoft.Resources/deployments/webAppSubCreateWeb-xx-xx-app-xx-tst-aty-eus-99-dev",
  "message": "At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-deployment-operations for usage details.",
  "details": [
    {
      "code": "InternalServerError",
      "message": "There was an unexpected InternalServerError.  Please try again later.  x-ms-correlation-request-id: xxxx"
    }
  ]
}

该错误仅在通过字符串数组批量部署Web App时出现，无固定指向某个Web App，多数情况下部署正常。

相关代码 #

main文件代码

@batchSize(6)
module webAppSubCreateApi 'webAppSubCreate.bicep' = [for (web,i) in webApplicationsToCreateApi: {
  name: 'webAppSubCreateApi-${web}'
  params: {
    location: location
    createAppServicePlanId: createAppServicePlanApi.id
    identityId: identity.id
    vnetSubNetId: vnetSubNetId
    webapp: web
    appInsightsConnectionString: appInsights.properties.ConnectionString
  }
  dependsOn: [createAppServicePlanApi, identity, workspace]
}]

模块代码

param webapp string
param location string
param identityId string
param createAppServicePlanId string
param vnetSubNetId string
param appInsightsConnectionString string

//create web app instances, one for each web application in the list webApplicationsToCreate
resource createWebApp 'Microsoft.Web/sites@2023-01-01' =  { 
  name: webapp
  location: location
  kind: 'windows'
  identity: {
    type:'UserAssigned'
    userAssignedIdentities: {
      '${identityId}': {}     
    }  
  }
    properties: {
      httpsOnly: true
      serverFarmId: createAppServicePlanId
      reserved: false     
      vnetRouteAllEnabled: false
      siteConfig:{
        alwaysOn:true        
        netFrameworkVersion: '6.0'
        metadata:[
        {
          name: 'CURRENT_STACK'
          value: 'dotnet'
        }
        {
          name: 'netFrameworkVersion'
          value: 'v6.0'
        }               
      ]  
      appSettings:[
        {
          name: 'APPLICATIONINSIGHTS_CONNECTION_STRING'
          value: appInsightsConnectionString
        }
      ]         
    }    
    virtualNetworkSubnetId:vnetSubNetId    
  }
}

output webappparentname string = createWebApp.name

问题分析与优化方案 #

从代码来看，不存在明显的语法或逻辑失误，这类InternalServerError多属于Azure服务端的暂态问题，通常由并发请求压力、资源竞争或服务端临时故障导致。可以通过以下优化措施降低错误发生概率：

• 降低并发部署批次大小：当前配置@batchSize(6)，可尝试调低至3-4。过高的并发数会增加Azure资源提供方的处理压力，容易触发暂态错误。
• 添加部署重试机制：在执行部署命令时配置重试策略，比如使用Azure CLI时添加--retries 3 --retry-interval 30参数，让部署工具自动重试暂态失败的操作。
• 拆分部署阶段：将Web App的批量部署拆分为多个阶段，比如先部署一半实例，待全部成功后再部署剩余部分。可以通过新增中间模块或手动分批次执行部署来实现，避免一次性发起大量请求。
• 检查子网资源配额：确认Web App绑定的子网有足够的可用IP地址，每个Web App实例会占用子网中的一个IP，IP资源不足可能触发服务端异常。
• 更新资源API版本：尝试将Web App的API版本从2023-01-01升级到最新稳定版（如2024-03-01），新版本通常会修复已知的暂态问题和兼容性问题。
• 优化依赖资源引用：虽然已配置dependsOn，但大型部署中依赖资源的就绪可能存在延迟。可尝试将依赖资源的ID提前解析为静态参数传入，而非在部署时动态引用，确保Web App部署时依赖资源已完全就绪。

内容的提问来源于stack exchange，提问作者Damo