Merge pull request #293343 from TimShererWithAquent/us345675-05

Freshness Edit: Azure App Service (5 of several)

Author: denrea

articles/app-service/deploy-zip.md

@@ -1,11 +1,12 @@
 ---
 title: Deploy files to App Service
-description: Learn to deploy various app packages or discrete libraries, static files, or startup scripts to Azure App Service
+description: Learn to deploy various app packages or discrete libraries, static files, or startup scripts to Azure App Service.
 ms.topic: article
-ms.date: 01/26/2024
+ms.date: 01/24/2025
 ms.custom: devx-track-azurecli
 author: cephalin
 ms.author: cephalin
+#customer intent: As a web app developer, I want to deploy my Azure App Service code as a ZIP, WAR, JAR, or EAR package or deploy individual files.
 ---
 
 # Deploy files to App Service
@@ -24,54 +25,54 @@ To complete the steps in this article, [create an App Service app](./index.yml),
 
 ## Deploy a ZIP package
 
-When you deploy a ZIP package, App Service unpacks its contents in the default path for your app (`D:\home\site\wwwroot` for Windows, `/home/site/wwwroot` for Linux).
+When you deploy a ZIP package, App Service unpacks its contents in the default path for your app:  `D:\home\site\wwwroot` for Windows, `/home/site/wwwroot` for Linux.
 
-This ZIP package deployment uses the same Kudu service that powers continuous integration-based deployments. Kudu supports the following functionality for ZIP package deployment: 
+This ZIP package deployment uses the same Kudu service that powers continuous integration-based deployments. Kudu supports the following functionality for ZIP package deployment:
 
 - Deletion of files left over from a previous deployment.
 - Option to turn on the default build process, which includes package restore.
 - Deployment customization, including running deployment scripts.  
-- Deployment logs. 
-- A package size limit of 2048 MB.
+- Deployment logs.
+- A package size limit of 2048 megabytes.
 
 > [!NOTE]
-> Files in the ZIP package are copied only if their timestamps don't match what is already deployed. 
+> Files in the ZIP package are copied only if their timestamps don't match what is already deployed.
 
-#### With zip deploy UI in Kudu
+### With zip deploy UI in Kudu
 
-In the browser, navigate to `https://<app_name>.scm.azurewebsites.net/ZipDeployUI` (see [note at top](#dnl-note)).
+In the browser, navigate to `https://<app_name>.scm.azurewebsites.net/ZipDeployUI`. For the app name, see the [note at top](#dnl-note).
 
 Upload the ZIP package you created in [Create a project ZIP package](#create-a-project-zip-package) by dragging it to the file explorer area on the web page.
 
-When deployment is in progress, an icon in the top right corner shows you the progress in percentage. The page also shows verbose messages for the operation below the explorer area. When deployment completes, the last message should say `Deployment successful`.
+When deployment is in progress, an icon in the top right corner shows you the progress in percentage. The page also shows verbose messages for the operation below the explorer area. When deployment completes, the last message should say *Deployment successful*.
 
-The above endpoint doesn't work for Linux App Services at this time. Consider using FTP or the [ZIP deploy API](./faq-app-service-linux.yml) instead.
+This endpoint doesn't work for Linux App Services at this time. Consider using FTP or the [ZIP deploy API](./faq-app-service-linux.yml) instead.
 
-#### Without zip deploy UI in Kudu
+### Without zip deploy UI in Kudu
 
 # [Azure CLI](#tab/cli)
 
 Deploy a ZIP package to your web app by using the [az webapp deploy](/cli/azure/webapp#az-webapp-deploy) command. The CLI command uses the [Kudu publish API](#kudu-publish-api-reference) to deploy the files and can be fully customized.
 
 The following example pushes a ZIP package to your site. Specify the path to your local ZIP package for `--src-path`.
 
-```azurecli-interactive
+```azurecli
 az webapp deploy --resource-group <group-name> --name <app-name> --src-path <zip-package-path>
 ```
 
-This command restarts the app after deploying the ZIP package. 
+This command restarts the app after deploying the ZIP package.
 
 # [Azure PowerShell](#tab/powershell)
 
-The following example uses [Publish-AzWebapp](/powershell/module/az.websites/publish-azwebapp) to upload the ZIP package. Replace the placeholders `<group-name>`, `<app-name>`, and `<zip-package-path>`
+The following example uses [Publish-AzWebapp](/powershell/module/az.websites/publish-azwebapp) to upload the ZIP package. Replace the placeholders *\<group-name>*, *\<app-name>*, and *\<zip-package-path>*
 
-```azurepowershell-interactive
+```azurepowershell
 Publish-AzWebApp -ResourceGroupName Default-Web-WestUS -Name MyApp -ArchivePath <zip-package-path> 
 ```
 
 # [Kudu API](#tab/api)
 
-The following example uses the cURL tool to deploy a ZIP package. Replace the placeholders `<zip-package-path>` and `<app-name>`. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+The following example uses the cURL tool to deploy a ZIP package. Replace the placeholders *\<zip-package-path>* and *\<app-name>*. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -90,7 +91,7 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see the [note at top](#dnl-note).
 
 # [ARM template](#tab/arm)
 
@@ -102,7 +103,7 @@ ARM templates only support [deployments from remotely hosted packages](#deploy-t
 
 By default, the deployment engine assumes that a ZIP package is ready to run as-is and doesn't run any build automation. To enable the same build automation as in a [Git deployment](deploy-local-git.md), set the `SCM_DO_BUILD_DURING_DEPLOYMENT` app setting by running the following command in the [Cloud Shell](https://shell.azure.com):
 
-```azurecli-interactive
+```azurecli
 az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings SCM_DO_BUILD_DURING_DEPLOYMENT=true
 ```
 
@@ -112,29 +113,29 @@ For more information, see [Kudu documentation](https://github.com/projectkudu/ku
 
 You can deploy your [WAR](https://wikipedia.org/wiki/WAR_(file_format)), [JAR](https://wikipedia.org/wiki/JAR_(file_format)), or [EAR](https://wikipedia.org/wiki/EAR_(file_format)) package to App Service to run your Java web app using the Azure CLI, PowerShell, or the Kudu publish API.
 
-The deployment process shown here puts the package on the app's content share with the right naming convention and directory structure (see [Kudu publish API reference](#kudu-publish-api-reference)), and it's the recommended approach. If you deploy WAR/JAR/EAR packages using [FTP](deploy-ftp.md) or WebDeploy instead, you might see unknown failures due to mistakes in the naming or structure.
+The deployment process shown here puts the package on the app's content share with the right naming convention and directory structure. For more information, see [Kudu publish API reference](#kudu-publish-api-reference). We recommend this approach. If you deploy WAR/JAR/EAR packages using [FTP](deploy-ftp.md) or WebDeploy instead, you might see unknown failures due to mistakes in the naming or structure.
 
 # [Azure CLI](#tab/cli)
 
 Deploy a WAR package to Tomcat or JBoss EAP by using the [az webapp deploy](/cli/azure/webapp#az-webapp-deploy) command. Specify the path to your local Java package for `--src-path`.
 
-```azurecli-interactive
+```azurecli
 az webapp deploy --resource-group <group-name> --name <app-name> --src-path ./<package-name>.war
 ```
 
 The CLI command uses the [Kudu publish API](#kudu-publish-api-reference) to deploy the package and can be fully customized.
 
 # [Azure PowerShell](#tab/powershell)
 
-The following example uses [Publish-AzWebapp](/powershell/module/az.websites/publish-azwebapp) to upload the .war file. Replace the placeholders `<group-name>`, `<app-name>`, and `<package-path>` (only WAR and JAR files are supported in Azure PowerShell).
+The following example uses [Publish-AzWebapp](/powershell/module/az.websites/publish-azwebapp) to upload the WAR file. Replace the placeholders *\<group-name>*, *\<app-name>*, and *\<package-path>*. Azure PowerShell supports only WAR and JAR files.
 
 ```powershell
 Publish-AzWebapp -ResourceGroupName <group-name> -Name <app-name> -ArchivePath <package-path>
 ```
 
 # [Kudu API](#tab/api)
 
-The following example uses the cURL tool to deploy a .war, .jar, or .ear file. Replace the placeholders `<file-path>`, `<app-name>`, and `<package-type>` (`war`, `jar`, or `ear`, accordingly). If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+The following example uses the cURL tool to deploy a WAR, JAR, or EAR file. Replace the placeholders *\<file-path>*, *\<app-name>*, and *\<package-type>* (`war`, `jar`, or `ear`). If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -153,9 +154,9 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see the [note at top](#dnl-note).
 
-For more information, see [Kudu publish API reference](#kudu-publish-api-reference)
+For more information, see [Kudu publish API reference](#kudu-publish-api-reference).
 
 # [ARM template](#tab/arm)
 
@@ -171,7 +172,7 @@ Deploy a startup script, library, and static file to your web app by using the [
 
 If you deploy a startup script this way, App Service automatically uses your script to start your app.
 
-The CLI command uses the [Kudu publish API](#kudu-publish-api-reference) to deploy the files and can be fully customized.
+The CLI command uses the [Kudu publish API](#kudu-publish-api-reference) to deploy the files. The command can be fully customized.
 
 ### Deploy a startup script
 
@@ -199,7 +200,7 @@ Not supported. See Azure CLI or Kudu API.
 
 ### Deploy a startup script
 
-The following example uses the cURL tool to deploy a startup file for the application. Replace the placeholders `<startup-file-path>` and `<app-name>`. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+The following example uses the cURL tool to deploy a startup file for the application. Replace the placeholders *\<startup-file-path>* and *\<app-name>*. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -218,11 +219,11 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see the [note at top](#dnl-note).
 
 ### Deploy a library file
 
-The following example uses the cURL tool to deploy a library file for the application. Replace the placeholders `<lib-file-path>` and `<app-name>`. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+The following example uses the cURL tool to deploy a library file for the application. Replace the placeholders *\<lib-file-path>* and *\<app-name>*. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -241,11 +242,11 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note).
 
 ### Deploy a static file
 
-The following example uses the cURL tool to deploy a config file for the application. Replace the placeholders `<config-file-path>` and `<app-name>`. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+The following example uses the cURL tool to deploy a config file for the application. Replace the placeholders *\<config-file-path>* and *\<app-name>*. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -264,7 +265,7 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see the [note at top](#dnl-note).
 
 # [ARM template](#tab/arm)
 
@@ -282,7 +283,7 @@ The remote URL can be any publicly accessible location, but it's best to use a b
 
 Use the `az webapp deploy` command like you would in the other sections, but use `--src-url` instead of `--src-path`. The following example uses the `--src-url` parameter to specify the URL of a ZIP file hosted in an Azure Storage account.
 
-```azurecli-interactive
+```azurecli
 az webapp deploy --resource-group <group-name> --name <app-name> --src-url "https://storagesample.blob.core.windows.net/sample-container/myapp.zip?sv=2021-10-01&sb&sig=slk22f3UrS823n4kSh8Skjpa7Naj4CG3 --type zip
 ```
 
@@ -292,7 +293,7 @@ Not supported. See Azure CLI, Kudu API, or ARM template.
 
 # [Kudu API](#tab/api)
 
-Invoke the [Kudu publish API](#kudu-publish-api-reference) like you would in the other sections, but instead of uploading a file, pass in a JSON object with `packageUri` in the request body. The following examples use this method to specify the URL of a ZIP file hosted in an Azure Storage account. Note the type is still specified as a query string. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in `<username>` and `<password>`.
+Invoke the [Kudu publish API](#kudu-publish-api-reference) like you would in the other sections. Instead of uploading a file, pass in a JSON object with `packageUri` in the request body. The following examples use this method to specify the URL of a ZIP file hosted in an Azure Storage account. The type is still specified as a query string. If you choose basic authentication, supply the [deployment credentials](deploy-configure-credentials.md) in *\<username>* and *\<password>*.
 
 ```bash
 # Microsoft Entra authentication
@@ -313,11 +314,11 @@ curl -X POST \
 ```
 
 > [!NOTE]
-> For the actual fully qualified domain name to use in the URL, see [note at top](#dnl-note)
+> For the actual fully qualified domain name to use in the URL, see the [note at top](#dnl-note).
 
 # [ARM template](#tab/arm)
 
-Add the following JSON to your ARM template. Replace the placeholder `<app-name>`. 
+Add the following JSON to your ARM template. Replace the placeholder *\<app-name>*.
 
 ```json
 {
@@ -347,23 +348,21 @@ Use the following reference to help you configure the properties:
 
 ## Kudu publish API reference
 
-The `publish` Kudu API allows you to specify the same parameters from the CLI command as URL query parameters. To authenticate with the Kudu REST API, it's best to use token authentication, but you can also use basic authentication with your app's [deployment credentials](deploy-configure-credentials.md#userscope).
+The `publish` Kudu API allows you to specify the same parameters from the CLI command as URL query parameters. To authenticate with the Kudu REST API, we recommend token authentication, but you can also use basic authentication with your app's [deployment credentials](deploy-configure-credentials.md#userscope).
 
 The following table shows the available query parameters, their allowed values, and descriptions.
 
 | Key | Allowed values | Description | Required | Type  |
 |-|-|-|-|-|
-| `type` | `war`\|`jar`\|`ear`\|`lib`\|`startup`\|`static`\|`zip` | The type of the artifact being deployed, this sets the default target path and informs the web app how the deployment should be handled. <br/> - `type=zip`: Deploy a ZIP package by unzipping the content to `/home/site/wwwroot`. `target-path` parameter is optional. <br/> - `type=war`: Deploy a WAR package. By default, the WAR package is deployed to `/home/site/wwwroot/app.war`. The target path can be specified with `target-path`. <br/> - `type=jar`: Deploy a JAR package to `/home/site/wwwroot/app.jar`. The `target-path` parameter is ignored <br/> - `type=ear`: Deploy an EAR package to `/home/site/wwwroot/app.ear`. The `target-path` parameter is ignored <br/> - `type=lib`: Deploy a JAR library file. By default, the file is deployed to `/home/site/libs`. The target path can be specified with `target-path`. <br/> - `type=static`: Deploy a static file (such as a script). By default, the file is deployed to `/home/site/wwwroot`. <br/> - `type=startup`: Deploy a script that App Service automatically uses as the startup script for your app. By default, the script is deployed to `D:\home\site\scripts\<name-of-source>` for Windows and `home/site/wwwroot/startup.sh` for Linux. The target path can be specified with `target-path`. | Yes | String |
+| `type` | `war`\|`jar`\|`ear`\|`lib`\|`startup`\|`static`\|`zip` | The type of the artifact being deployed, this sets the default target path and informs the web app how the deployment should be handled. <br/> - `type=zip`: Deploy a ZIP package by unzipping the content to `/home/site/wwwroot`. `target-path` parameter is optional. <br/> - `type=war`: Deploy a WAR package. By default, the WAR package is deployed to `/home/site/wwwroot/app.war`. The target path can be specified with `target-path`. <br/> - `type=jar`: Deploy a JAR package to `/home/site/wwwroot/app.jar`. The `target-path` parameter is ignored <br/> - `type=ear`: Deploy an EAR package to `/home/site/wwwroot/app.ear`. The `target-path` parameter is ignored <br/> - `type=lib`: Deploy a JAR library file. By default, the file is deployed to `/home/site/libs`. The target path can be specified with `target-path`. <br/> - `type=static`: Deploy a static file, such as a script. By default, the file is deployed to `/home/site/wwwroot`. <br/> - `type=startup`: Deploy a script that App Service automatically uses as the startup script for your app. By default, the script is deployed to `D:\home\site\scripts\<name-of-source>` for Windows and `home/site/wwwroot/startup.sh` for Linux. The target path can be specified with `target-path`. | Yes | String |
 | `restart` | `true`\|`false` | By default, the API restarts the app following the deployment operation (`restart=true`). To deploy multiple artifacts, prevent restarts on the all but the final deployment by setting `restart=false`. | No | Boolean |
 | `clean` | `true`\|`false` | Specifies whether to clean (delete) the target deployment before deploying the artifact there. | No | Boolean |
 | `ignorestack` | `true`\|`false` | The publish API uses the `WEBSITE_STACK` environment variable to choose safe defaults depending on your site's language stack. Setting this parameter to `false` disables any language-specific defaults. | No | Boolean |
 | `target-path` | An absolute path | The absolute path to deploy the artifact to. For example, `"/home/site/deployments/tools/driver.jar"`, `"/home/site/scripts/helper.sh"`. | No | String |
 
-## Next steps
+## Related content
 
 For more advanced deployment scenarios, try [deploying to Azure with Git](deploy-local-git.md). Git-based deployment to Azure enables version control, package restore, MSBuild, and more.
 
-## More resources
-
-* [Kudu: Deploying from a zip file](https://github.com/projectkudu/kudu/wiki/Deploying-from-a-zip-file)
-* [Environment variables and app settings reference](reference-app-settings.md)
+- [Kudu: Deploying from a zip file](https://github.com/projectkudu/kudu/wiki/Deploying-from-a-zip-file)
+- [Environment variables and app settings reference](reference-app-settings.md)