Azure appservice deployment does not clean root directory

DSenthil 20

I am issuing below command to deploy to a Azure appservice in my Jenkins pipeline script. But I get below issues.

Command:

az webapp deploy --clean true --restart true --resource-group

Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-05T14:13:08.07+00:00
Hi DSenthil ,
Welcome to the Microsoft Q&A Platform!
To deploy your application to Azure App Service with a clean root directory, use the correct az webapp deploy .

az webapp deploy \ --clean true \ --restart true \ --resource-group <RESOURCE_GROUP> \ --name <WEBAPP_NAME> \ --src-path <PATH_TO_ARTIFACT>

--name: Check your webapp name.

--src-path: Check the deployment is correct.

Ensure the App Service stack supports the deployment artifact type.

If --clean doesn't fully remove files once's stop and start the app.
az webapp stop --name <WEBAPP_NAME> --resource-group <RESOURCE_GROUP> az webapp deploy --clean true --restart true --resource-group <RESOURCE_GROUP> --name <WEBAPP_NAME> --src-path <PATH_TO_ARTIFACT> az webapp start --name <WEBAPP_NAME> --resource-group <RESOURCE_GROUP>

Update Azure CLI to the latest version.
az upgrade

Confirm your Azure credentials have Contributor or higher permissions on the App Service and Resource Group.

Use the --debug flag to capture detailed logs.
az webapp deploy --clean true --restart true --resource-group <RESOURCE_GROUP> --name <WEBAPP_NAME> --src-path <PATH_TO_ARTIFACT> --debug

Navigate to App Service > Deployment Center > Logs.
Azure CLI az webapp deploy documentation
https://learn.microsoft.com/en-us/azure/app-service/deploy-best-practices
f the answer is helpful, please click "Accept Answer" and kindly upvote it.
DSenthil 20 Reputation points

2024-12-06T04:24:23.6633333+00:00

Thank you for the response @Shree Hima Bindu Maganti . Actually my deployment command which I posted was not complete. Not sure why it trimmed next half. Below is the full one

az webapp deploy --async true --clean true --resource-group <RESOURCE_GROUP> --subscription <SUBSCRIPTION> --name <WEBAPP_NAME> --src-path <SOURCE_ZIPFILE> --target-path <TARGET_PATH> --type zip --timeout 4200

I will try to stop, deploy and start the app.

Now If I run the deployment command asyncronously I am not getting 500 error. I am doing more testing. I have one more challege now.

I want to deploy to a folder called 'mywebapp' in root directory wwwroot. Earlier with 'az webapp deployment' command if I set the appsetting as "SCM_TARGET_PATH = 'mywebapp'", it was working. Same is not working with 'az webapp deploy'

So instead of 'SCM_TARGET_PATH' I set "DEPLOYMENT_TARGET = 'mywebapp'". This is also not working with 'az webapp deploy'.

But if I set the full path then it is working. Ex: DEPLOYMENT_TARGET = 'C:/home/site/wwwroot/mywebapp'.

The challenge here is there are many apps using SCM_TARGET_PATH with just relative path for both Windows and Linux appservice. If I want to migrate to new webapp command 'az webapp deploy' how will I dynamically know the root directroy path? is there a way to make it work with just relative path?

Appreciate your help.
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-06T07:26:01.0466667+00:00
Hi DSenthil ,
Thank you for your detailed follow-up.
Azure App Service uses platform-specific paths for deployments:

Windows: C:/home/site/wwwroot

Linux: /home/site/wwwroot

With the az webapp deploy command, the DEPLOYMENT_TARGET app setting must specify an absolute path, not a relative one. Since SCM_TARGET_PATH previously supported relative paths, the challenge lies in dynamically identifying the root path for your App Service platform.
Use the HOME environment variable available in Azure App Service to construct the absolute deployment path.

$homePath = (az webapp config appsettings list --name <WEBAPP_NAME> --resource-group <RESOURCE_GROUP> --query "[?name=='HOME'].value" -o tsv) $deployPath = "$homePath/site/wwwroot/mywebapp" az webapp config appsettings set --name <WEBAPP_NAME> --resource-group <RESOURCE_GROUP> --settings "DEPLOYMENT_TARGET=$deployPath"

If using the az webapp deploy command, specify the full path explicitly in the --target-path parameter.

az webapp deploy \ --async true \ --clean true \ --resource-group <RESOURCE_GROUP> \ --subscription <SUBSCRIPTION> \ --name <WEBAPP_NAME> \ --src-path <SOURCE_ZIPFILE> \ --target-path "/home/site/wwwroot/mywebapp" \ --type zip \ --timeout 4200

Use the Azure CLI to identify the app’s platform (reserved: true indicates Linux). Create a script to determine the correct root path dynamically.

osType=$(az webapp show --name <WEBAPP_NAME> --resource-group <RESOURCE_GROUP> --query "reserved" -o tsv) if [ "$osType" == "true" ]; then targetPath="/home/site/wwwroot/mywebapp" else targetPath="C:/home/site/wwwroot/mywebapp" fi az webapp deploy \ --async true \ --clean true \ --resource-group <RESOURCE_GROUP> \ --subscription <SUBSCRIPTION> \ --name <WEBAPP_NAME> \ --src-path <SOURCE_ZIPFILE> \ --target-path "$targetPath" \ --type zip \ --timeout 4200

SCM_TARGET_PATH is not supported in az webapp deploy. Instead, transition to using DEPLOYMENT_TARGET with the absolute path as mentioned above. If retaining relative paths is critical, consider submitting a GitHub feature request for enhanced support in az webapp.
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-12T02:43:36.1666667+00:00

Hi DSenthil ,

Following up to see if you have chance to check my previous response and help us with requested information to check and assist you further on this.
DSenthil 20 Reputation points

2024-12-12T03:26:25.7866667+00:00
Hi @Shree Hima Bindu Maganti ,

Sorry! I was out for few days and started my testing.

The subfolder deployment to Azure app service is working only when I set the DEPLOYMENT_TARGET as appsetting.

Following are my scenarios.

First deployment to a subfolder called 'myfirstapp' by setting DEPLOYMENT_TARGET as "C:/home/site/wwwroot/mywebapps"

Before second deployment, I have deleted the DEPLOYMENT_TARGET appsetting and passed Jenkins parameter "targetPath: C:/home/site/wwwroot/mysecondapp"

This targetPath is directly set as "--target-path $targetPath". But this time deployment is failing with error as 'Invalid directory name'

But instead of --target-path, if I set the appsetting DEPLOYMENT_TARGET as "C:/home/site/wwwroot/mysecondapp" then it is working fine.
DSenthil 20 Reputation points

2024-12-12T03:58:57.1266667+00:00

Sure. Thank you @Shree Hima Bindu Maganti
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-13T15:45:13.6366667+00:00

Hi DSenthil ,

Following up to see if you have chance to check my previous response and help us with requested information is helpful.
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-16T17:06:54.17+00:00

Hi DSenthil ,

Following up to see if you have chance to check my previous response and help us with requested information is helpful.
DSenthil 20 Reputation points

2024-12-17T04:54:13.15+00:00

Hi @Shree Hima Bindu Maganti - As you suggested, I am using DEPLOYMENT_TARGET and it is working as expected.

I did not raise Github issue for Azure Cli yet. I am not sure where to raise it.
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-17T17:01:55.49+00:00

Hi DSenthil,

Glad to hear DEPLOYMENT_TARGET is working as expected!

If you need to raise a GitHub issue for Azure CLI,

Azure CLI GitHub Issues Page: https://github.com/Azure/azure-cli/issues
Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-18T17:43:27.6033333+00:00

Hi DSenthil,

I'm glad that you were able to resolve your issue and thank you for posting your solution so that others experiencing the same thing can easily reference this! Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others ", I'll repost your solution to accept the answer.

Accepted answer

Shree Hima Bindu Maganti 2,415 Reputation points Microsoft Vendor

2024-12-12T03:42:38.6766667+00:00
Hi @DSenthil ,
Thankyou for Your Response.
As You mentioned DEPLOYMENT_TARGET works reliably and Subfolder deployments are successful when DEPLOYMENT_TARGET is set as an app setting.

--target-path fails while Using --target-path directly results in an error ("Invalid directory name").

Continue using DEPLOYMENT_TARGET for Subfolder Deployments.Set DEPLOYMENT_TARGET as an app setting before deployment.

az webapp config appsettings set \ --name <WEBAPP_NAME> \ --resource-group <RESOURCE_GROUP> \ --settings "DEPLOYMENT_TARGET=C:/home/site/wwwroot/<subfolder>" az webapp deploy \ --resource-group <RESOURCE_GROUP> \ --name <WEBAPP_NAME> \ --src-path <SOURCE_ZIPFILE> \ --clean true

Update the DEPLOYMENT_TARGET dynamically in the pipeline before deployment.
sh """ az webapp config appsettings set \ --name ${WEBAPP_NAME} \ --resource-group ${RESOURCE_GROUP} \ --settings "DEPLOYMENT_TARGET=${targetPath}" az webapp deploy \ --resource-group ${RESOURCE_GROUP} \ --name ${WEBAPP_NAME} \ --src-path ${SOURCE_ZIPFILE} \ --clean true """ sh """ az webapp config appsettings set \ --name ${WEBAPP_NAME} \ --resource-group ${RESOURCE_GROUP} \ --settings "DEPLOYMENT_TARGET=${targetPath}" az webapp deploy \ --resource-group ${RESOURCE_GROUP} \ --name ${WEBAPP_NAME} \ --src-path ${SOURCE_ZIPFILE} \ --clean true """
Avoid --target-path Until Resolved this parameter is unreliable; raise a GitHub issue with Azure CLI for further investigation.

Azure App Service - Configure App Settings
Azure Web App Deployment CLI Docs
Azure Deployment Logs and Troubleshooting
You can mark it 'Accept Answer' and 'Upvote' if this helped you
Please sign in to rate this answer.

1 person found this answer helpful.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

1 additional answer

DSenthil 20 Reputation points

2024-12-06T04:10:13.92+00:00

If I use --async flag then I am not getting the 500 error. I am doing more testing
Please sign in to rate this answer.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Azure appservice deployment does not clean root directory

1 additional answer

Your answer