Merge pull request #278971 from dksimpson/tsk261306-dks-6

Refresh article: Run your functions from a package file [Task 261306]

Author: v-regandowner

articles/azure-functions/run-functions-from-deployment-package.md

@@ -1,9 +1,11 @@
 ---
 title: Run your functions from a package file in Azure 
-description: Have the Azure Functions runtime run your functions by mounting a deployment package file that contains your function app project files.
+description: Learn how to configure Azure Functions to run your function app from a deployment package file that contains your function app project.
+ms-service: azure-functions
 ms.topic: conceptual
-ms.date: 02/05/2022
+ms.date: 06/28/2024
 
+# Customer intent: As a function developer, I want to understand how to run my function app from a deployment package file, so I can make my function app run faster and easier to update.
 ---
 
 # Run your functions from a package file in Azure
@@ -14,26 +16,26 @@ This article describes the benefits of running your functions from a package. It
 
 ## Benefits of running from a package file
 
-There are several benefits to running from a package file:
+There are several benefits to running functions from a package file:
 
 + Reduces the risk of file copy locking issues.
 + Can be deployed to a production app (with restart).
-+ You can be certain of the files that are running in your app.
++ Verifies the files that are running in your app.
 + Improves the performance of [Azure Resource Manager deployments](functions-infrastructure-as-code.md).
-+ May reduce cold-start times, particularly for JavaScript functions with large npm package trees.
++ Reduces cold-start times, particularly for JavaScript functions with large npm package trees.
 
 For more information, see [this announcement](https://github.com/Azure/app-service-announcements/issues/84).
 
 ## Enable functions to run from a package
 
-To enable your function app to run from a package, add a `WEBSITE_RUN_FROM_PACKAGE` setting to your function app settings. The `WEBSITE_RUN_FROM_PACKAGE` setting can have one of the following values:
+To enable your function app to run from a package, add a `WEBSITE_RUN_FROM_PACKAGE` app setting to your function app. The `WEBSITE_RUN_FROM_PACKAGE` app setting can have one of the following values:
 
 | Value  | Description  |
 |---------|---------|
 | **`1`**  | Indicates that the function app runs from a local package file deployed in the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder of your function app.  |
 |**`<URL>`**  | Sets a URL that is the remote location of the specific package file you want to run. Required for functions apps running on Linux in a Consumption plan.  |
 
-The following table indicates the recommended `WEBSITE_RUN_FROM_PACKAGE` options for deployment to a specific operating system and hosting plan:
+The following table indicates the recommended `WEBSITE_RUN_FROM_PACKAGE` values for deployment to a specific operating system and hosting plan:
 
 | Hosting plan | Windows | Linux |
 | --- | --- | --- |
@@ -43,98 +45,91 @@ The following table indicates the recommended `WEBSITE_RUN_FROM_PACKAGE` options
 
 ## General considerations
 
-+ The package file must be .zip formatted. Tar and gzip formats aren't currently supported.
++ The package file must be .zip formatted. Tar and gzip formats aren't supported.
 + [Zip deployment](#integration-with-zip-deployment) is recommended.
 + When deploying your function app to Windows, you should set `WEBSITE_RUN_FROM_PACKAGE` to `1` and publish with zip deployment.
-+ When you run from a package, the `wwwroot` folder becomes read-only and you'll receive an error when writing files to this directory. Files are also read-only in the Azure portal.
-+ The maximum size for a deployment package file is currently 1 GB.
-+ You can't use local cache when running from a deployment package.
-+ If your project needs to use remote build, don't use the `WEBSITE_RUN_FROM_PACKAGE` app setting. Instead add the `SCM_DO_BUILD_DURING_DEPLOYMENT=true` deployment customization app setting. For Linux, also add the `ENABLE_ORYX_BUILD=true` setting. To learn more, see [Remote build](functions-deployment-technologies.md#remote-build).
++ When you run from a package, the `wwwroot` folder is read-only and you receive an error if you write files to this directory. Files are also read-only in the Azure portal.
++ The maximum size for a deployment package file is 1 GB.
++ You can't use the local cache when running from a deployment package.
++ If your project needs to use remote build, don't use the `WEBSITE_RUN_FROM_PACKAGE` app setting. Instead, add the `SCM_DO_BUILD_DURING_DEPLOYMENT=true` deployment customization app setting. For Linux, also add the `ENABLE_ORYX_BUILD=true` setting. For more information, see [Remote build](functions-deployment-technologies.md#remote-build).
 
 > [!NOTE]
-> WEBSITE_RUN_FROM_PACKAGE does not work with MSDeploy as described [here](https://github.com/projectkudu/kudu/wiki/MSDeploy-VS.-ZipDeploy). You will receive an error during deployment like `ARM-MSDeploy Deploy Failed`.  Change /MSDeploy to /ZipDeploy and this error will be resolved.
+> The `WEBSITE_RUN_FROM_PACKAGE` app setting does not work with MSDeploy as described in [MSDeploy VS. ZipDeploy](https://github.com/projectkudu/kudu/wiki/MSDeploy-VS.-ZipDeploy). You will receive an error during deployment, such as `ARM-MSDeploy Deploy Failed`. To resolve this error, hange `/MSDeploy` to `/ZipDeploy`.
 
-### Adding the WEBSITE_RUN_FROM_PACKAGE setting
+### Add the WEBSITE_RUN_FROM_PACKAGE setting
 
 [!INCLUDE [Function app settings](../../includes/functions-app-settings.md)]
 
-## Using WEBSITE_RUN_FROM_PACKAGE = 1
+## Use WEBSITE_RUN_FROM_PACKAGE = 1
 
 This section provides information about how to run your function app from a local package file.
 
 ### Considerations for deploying from an on-site package
 
-+ Using an on-site package is the recommended option for running from the deployment package, except on Linux hosted in a Consumption plan.
+<a name="troubleshooting"></a>
+
++ Using an on-site package is the recommended option for running from the deployment package, except when running on Linux hosted in a Consumption plan.
 + [Zip deployment](#integration-with-zip-deployment) is the recommended way to upload a deployment package to your site.
 + When not using zip deployment, make sure the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder has a file named `packagename.txt`. This file contains only the name, without any whitespace, of the package file in this folder that's currently running.
 
 ### Integration with zip deployment
 
-[Zip deployment][Zip deployment for Azure Functions] is a feature of Azure App Service that lets you deploy your function app project to the `wwwroot` directory. The project is packaged as a .zip deployment file. The same APIs can be used to deploy your package to the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder.
+Zip deployment is a feature of Azure App Service that lets you deploy your function app project to the `wwwroot` directory. The project is packaged as a .zip deployment file. The same APIs can be used to deploy your package to the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder.
 
-With the `WEBSITE_RUN_FROM_PACKAGE` app setting value of `1`, the zip deployment APIs copy your package to the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder instead of extracting the files to `c:\home\site\wwwroot` (Windows) or `/home/site/wwwroot` (Linux). It also creates the `packagename.txt` file. After a restart, the package is mounted to `wwwroot` as a read-only filesystem. For more information about zip deployment, see [Zip deployment for Azure Functions](deployment-zip-push.md).
+When you set the `WEBSITE_RUN_FROM_PACKAGE` app setting value to `1`, the zip deployment APIs copy your package to the `c:\home\data\SitePackages` (Windows) or `/home/data/SitePackages` (Linux) folder instead of extracting the files to `c:\home\site\wwwroot` (Windows) or `/home/site/wwwroot` (Linux). It also creates the `packagename.txt` file. After your function app is automatically restarted, the package is mounted to `wwwroot` as a read-only filesystem. For more information about zip deployment, see [Zip deployment for Azure Functions](deployment-zip-push.md).
 
 > [!NOTE]
-> When a deployment occurs, a restart of the function app is triggered. Function executions currently running during the deploy are terminated. Please review [Improve the performance and reliability of Azure Functions](performance-reliability.md#write-functions-to-be-stateless) to learn how to write stateless and defensive functions.
+> When a deployment occurs, a restart of the function app is triggered. Function executions currently running during the deploy are terminated. For information about how to write stateless and defensive functions, sett [Write functions to be stateless](performance-reliability.md#write-functions-to-be-stateless).
 
-## Using WEBSITE_RUN_FROM_PACKAGE = URL
+## Use WEBSITE_RUN_FROM_PACKAGE = URL
 
-This section provides information about how to run your function app from a package deployed to a URL endpoint. This option is the only one supported for running from a package on Linux hosted in a Consumption plan.
+This section provides information about how to run your function app from a package deployed to a URL endpoint. This option is the only one supported for running from a Linux-hosted package with a Consumption plan.
 
 ### Considerations for deploying from a URL
 
-<a name="troubleshooting"></a>
-
-+ Function apps running on Windows experience a slight increase in [cold start time](event-driven-scaling.md#cold-start) when the application package is deployed to a URL endpoint via `WEBSITE_RUN_FROM_PACKAGE = <URL>`.
++ Function apps running on Windows experience a slight increase in [cold-start time](event-driven-scaling.md#cold-start) when the application package is deployed to a URL endpoint via `WEBSITE_RUN_FROM_PACKAGE = <URL>`.
 + When you specify a URL, you must also [manually sync triggers](functions-deployment-technologies.md#trigger-syncing) after you publish an updated package.
 + The Functions runtime must have permissions to access the package URL.
-+ You shouldn't deploy your package to Azure Blob Storage as a public blob. Instead, use a private container with a [Shared Access Signature (SAS)](../storage/common/storage-sas-overview.md) or [use a managed identity](#fetch-a-package-from-azure-blob-storage-using-a-managed-identity) to enable the Functions runtime to access the package.
++ Don't deploy your package to Azure Blob Storage as a public blob. Instead, use a private container with a [shared access signature (SAS)](../storage/common/storage-sas-overview.md) or [use a managed identity](#fetch-a-package-from-azure-blob-storage-using-a-managed-identity) to enable the Functions runtime to access the package.
 + You must maintain any SAS URLs used for deployment. When an SAS expires, the package can no longer be deployed. In this case, you must generate a new SAS and update the setting in your function app. You can eliminate this management burden by [using a managed identity](#fetch-a-package-from-azure-blob-storage-using-a-managed-identity).
 + When running on a Premium plan, make sure to [eliminate cold starts](functions-premium-plan.md#eliminate-cold-starts).
-+ When running on a Dedicated plan, make sure you've enabled [Always On](dedicated-plan.md#always-on).
-+ You can use the [Azure Storage Explorer](../vs-azure-tools-storage-manage-with-storage-explorer.md) to upload package files to blob containers in your storage account.
++ When you're running on a Dedicated plan, ensure you enable [Always On](dedicated-plan.md#always-on).
++ You can use [Azure Storage Explorer](../vs-azure-tools-storage-manage-with-storage-explorer.md) to upload package files to blob containers in your storage account.
 
 ### Manually uploading a package to Blob Storage
 
-To deploy a zipped package when using the URL option, you must create a .zip compressed deployment package and upload it to the destination. This example deploys to a container in Blob Storage.
+To deploy a zipped package when using the URL option, you must create a .zip compressed deployment package and upload it to the destination. The following procedure deploys to a container in Blob Storage:
 
 1. Create a .zip package for your project using the utility of your choice.
 
-1. In the [Azure portal](https://portal.azure.com), search for your storage account name or browse for it in storage accounts.
+1. In the [Azure portal](https://portal.azure.com), search for your storage account name or browse for it in the storage accounts list.
 
 1. In the storage account, select **Containers** under **Data storage**.
 
 1. Select **+ Container** to create a new Blob Storage container in your account.
 
-1. In the **New container** page, provide a **Name** (for example, "deployments"), make sure the **Public access level** is **Private**, and select **Create**.
+1. In the **New container** page, provide a **Name** (for example, *deployments*), ensure the **Anonymous access level** is **Private**, and then select **Create**.
 
-1. Select the container you created, select **Upload**, browse to the location of the .zip file you created with your project, and select **Upload**.
+1. Select the container you created, select **Upload**, browse to the location of the .zip file you created with your project, and then select **Upload**.
 
-1. After the upload completes, choose your uploaded blob file, and copy the URL. You may need to generate a SAS URL if you aren't [using an identity](#fetch-a-package-from-azure-blob-storage-using-a-managed-identity)
+1. After the upload completes, choose your uploaded blob file, and copy the URL. If you aren't [using a managed identity](#fetch-a-package-from-azure-blob-storage-using-a-managed-identity), you might need to generate a SAS URL.
 
 1. Search for your function app or browse for it in the **Function App** page.
 
-1. In your function app, select **Configurations** under **Settings**.
+1. In your function app, expand **Settings**, and then select **Environment variables**.
 
-1. In the **Application Settings** tab, select **New application setting**
+1. In the **App settings** tab, select **+ Add**.
 
-1. Enter the value `WEBSITE_RUN_FROM_PACKAGE` for the **Name**, and paste the URL of your package in Blob Storage as the **Value**.
+1. Enter the value `WEBSITE_RUN_FROM_PACKAGE` for the **Name**, and paste the URL of your package in Blob Storage for the **Value**.
 
-1. Select **OK**. Then select  **Save** > **Continue** to save the setting and restart the app.
+1. Select **Apply**, and then select **Apply** and **Confirm** to save the setting and restart the function app.
 
-Now you can run your function in Azure to verify that deployment has succeeded using the deployment package .zip file.
-
-The following shows a function app configured to run from a .zip file hosted in Azure Blob storage:
-
-![WEBSITE_RUN_FROM_ZIP app setting](./media/run-functions-from-deployment-package/run-from-zip-app-setting-portal.png)
+Now you can run your function in Azure to verify that deployment of the deployment package .zip file was successful.
 
 ### Fetch a package from Azure Blob Storage using a managed identity
 
 [!INCLUDE [Run from package via Identity](../../includes/app-service-run-from-package-via-identity.md)]
 
-## Next steps
-
-> [!div class="nextstepaction"]
-> [Continuous deployment for Azure Functions](functions-continuous-deployment.md)
+## Related content
 
-[Zip deployment for Azure Functions]: deployment-zip-push.md
++ [Continuous deployment for Azure Functions](functions-continuous-deployment.md)

includes/app-service-run-from-package-via-identity.md

@@ -1,18 +1,18 @@
 ---
 author: mattchenderson
-ms.service: app-service
-ms.topic: include
-ms.date: 06/11/2021
 ms.author: mahender
+ms.service: app-service
 ms.subservice: web-apps
+ms.topic: include
+ms.date: 06/28/2024
 ---
 
-Azure Blob Storage can be configured to [authorize requests with Microsoft Entra ID](/azure/storage/blobs/authorize-access-azure-active-directory?toc=%2fazure%2fstorage%2fblobs%2ftoc.json). This means that instead of generating a SAS key with an expiration, you can instead rely on the application's [managed identity](/azure/app-service/overview-managed-identity). By default, the app's system-assigned identity will be used. If you wish to specify a user-assigned identity, you can set the `WEBSITE_RUN_FROM_PACKAGE_BLOB_MI_RESOURCE_ID` app setting to the resource ID of that identity. The setting can also accept "SystemAssigned" as a value, although this is the same as omitting the setting altogether.
+You can configure Azure Blob Storage to [authorize requests with Microsoft Entra ID](/azure/storage/blobs/authorize-access-azure-active-directory?toc=%2fazure%2fstorage%2fblobs%2ftoc.json). This configuration means that instead of generating a SAS key with an expiration, you can instead rely on the application's [managed identity](/azure/app-service/overview-managed-identity). By default, the app's system-assigned identity is used. If you wish to specify a user-assigned identity, you can set the `WEBSITE_RUN_FROM_PACKAGE_BLOB_MI_RESOURCE_ID` app setting to the resource ID of that identity. The setting can also accept `SystemAssigned` as a value, which is equivalent to omitting the setting.
 
 To enable the package to be fetched using the identity:
 
 1. Ensure that the blob is [configured for private access](/azure/storage/blobs/anonymous-read-access-configure#set-the-anonymous-access-level-for-a-container).
 
 1. Grant the identity the [Storage Blob Data Reader](/azure/role-based-access-control/built-in-roles#storage-blob-data-reader) role with scope over the package blob. See [Assign an Azure role for access to blob data](/azure/storage/blobs/assign-azure-role-data-access) for details on creating the role assignment.
 
-1. Set the `WEBSITE_RUN_FROM_PACKAGE` application setting to the blob URL of the package. This will likely be of the form "https://{storage-account-name}.blob.core.windows.net/{container-name}/{path-to-package}" or similar.
+1. Set the `WEBSITE_RUN_FROM_PACKAGE` application setting to the blob URL of the package. This URL is usually of the form `https://{storage-account-name}.blob.core.windows.net/{container-name}/{path-to-package}` or similar.