Azure Web App deploy: Web Deploy cannot modify the file on the destination because it is locked by an external process

Question

I am using the "Azure Web App Deployment" build step in VSTS to publish an ASP.NET Core API to an Azure Web App:

Occasionally, this step breaks with the following error:

[error]Microsoft.Web.Deployment.DeploymentDetailedClientServerException: Web Deploy cannot modify the file 'MyProject.Api.exe' on the destination because it is locked by an external process. In order to allow the publish operation to succeed, you may need to either restart your application to release the lock, or use the AppOffline rule handler for .Net applications on your next publish attempt. Learn more at: http://go.microsoft.com/fwlink/?LinkId=221672#ERROR_FILE_IN_USE.

This GitHub issue raises the same issue, but there is no suggested solution using the Azure Web App Deployment build step.

Answer 1

As per a separate thread in the Microsoft Github repo here, there's a hacky workaround where if you add the following key to the Azure Appsettings, it can help resolve the locked file deployment error:

MSDEPLOY_RENAME_LOCKED_FILES = 1

I'm not sure how long this appsetting hack will be supported, but it did help solve the issue for me personally.

Answer 2

I was struggling with the same locking issue.
There are now a new Tasks (in Preview) that you can add for starting and stopping the App Service:

Add a stop task before deployment and a start task after the deployment.

This did the trick for me.

Answer 3

You can restart the Function App to release the lock. After that you should be able to deploy.

Answer 4

You can create two Power Shell scripts:

stopapp.ps1:

param($websiteName)
$website = Get-AzureWebsite -Name $websiteName
Stop-AzureWebsite -Name $websiteName

startapp.ps1:

param($websiteName)
$website = Get-AzureWebsite -Name $websiteName
Start-AzureWebsite -Name $websiteName

And then add an "Azure PowerShell" task before and after "Azure Web App Deployment" task to stop the web app before deploy and start the app after deploy.

Answer 5

I was getting the same error while I was trying to publish my Azure Function App. I followed this Microsoft document and did the following steps.

1. Right click on your Project and select Edit ....csproj

2. Add <EnableMSDeployAppOffline>true</EnableMSDeployAppOffline> in PropertyGroup tag

   <PropertyGroup>
     <TargetFramework>netcoreapp2.1</TargetFramework>
     <AzureFunctionsVersion>v2</AzureFunctionsVersion>
     <EnableMSDeployAppOffline>true</EnableMSDeployAppOffline>
   </PropertyGroup>
   

3. Save and Rebuild your solution

4. Now publish again

If that didn't work for you, you can always add MSDEPLOY_RENAME_LOCKED_FILES=1 as Mr. Ben mentioned in his answer, to your Application settings. You can do that from Visual Studio itself.

Hope it helps

Answer 6

Taking website offline while release should do the trick.

Answer 7

1. Stop app service
2. deploy code
3. Start app service

Answer 8

Before you open too many cans of worms on this, wait 30-60 seconds and try publishing your app a second time. It appears that this sometimes happens because the stop request that gets issued to the service either returns before the service has completely stopped or maybe Visual Studio is not waiting long enough for this operation to finish. Each time I've encountered the problem, waiting and retrying the publish worked the second time.

Answer 9

There are some dedicated tasks for asp.net core projects because the deployment process is a little bit different.
You can get those from the marketplace for free, check out DNX Tasks vsts marketplace
Hope that helps!!

Answer 10

Eddie's answer was close to what I needed, the only thing that was missing was a way to specify the deployment slot:

stopapp.ps1

param($websiteName, $websiteSlot)
$website = Get-AzureWebsite -Name $websiteName -Slot $websiteSlot
Stop-AzureWebsite -Name $websiteName -Slot $websiteSlot

startapp.ps1

param($websiteName, $websiteSlot)
$website = Get-AzureWebsite -Name $websiteName -Slot $websiteSlot
Start-AzureWebsite -Name $websiteName -Slot $websiteSlot

And then on your Azure PowerShell task Script Arguments could be something like this:

-websiteName "{mywebsite}" -websiteSlot "{mydeploymentslot}"

Answer 11

Juste add

<EnableMSDeployAppOffline>true</EnableMSDeployAppOffline>

to your publish profile(.pubxml).

Answer 12

Mine is a onprem release pipeline, and this is what I did.