Skip to content

Commit 586bd83

Browse files
committed
updated deployment docs to be more flex aware
1 parent 9dc18c7 commit 586bd83

File tree

5 files changed

+17
-10
lines changed

5 files changed

+17
-10
lines changed

articles/azure-functions/deployment-zip-push.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 08/12/2018
1111

1212
This article describes how to deploy your function app project files to Azure from a .zip (compressed) file. You learn how to do a push deployment, both by using Azure CLI and by using the REST APIs. [Azure Functions Core Tools](functions-run-local.md) also uses these deployment APIs when publishing a local project to Azure.
1313

14-
Zip deployment is also an easy way to run your functions from the deployment package. To learn more, see [Run your functions from a package file in Azure](run-functions-from-deployment-package.md).
14+
Zip deployment is also an easy way to [run your functions from a package file in Azure](run-functions-from-deployment-package.md). It is the default deployment technology in the [Consumption](./consumption-plan.md), [Elastic Premium](./functions-premium-plan.md), and [Dedicated (App Service)](./dedicated-plan.md) hosting plans. The [Flex Consumption](./flex-consumption-plan.md) plan does not support zip deployment.
1515

1616
Azure Functions has the full range of continuous deployment and integration options that are provided by Azure App Service. For more information, see [Continuous deployment for Azure Functions](functions-continuous-deployment.md).
1717

articles/azure-functions/functions-deployment-technologies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deployment technologies in Azure Functions
33
description: Learn the different ways you can deploy code to Azure Functions.
44
ms.custom: vs-azure, vscode-azure-extension-update-not-needed, build-2023, build-2024
55
ms.topic: conceptual
6-
ms.date: 09/27/2024
6+
ms.date: 11/07/2024
77
---
88

99
# Deployment technologies in Azure Functions
@@ -18,7 +18,7 @@ The following table describes the available deployment methods for your code pro
1818

1919
| Deployment type | Methods | Best for... |
2020
| --- | --- | --- |
21-
| Tools-based | &bull;&nbsp;[Visual&nbsp;Studio&nbsp;Code&nbsp;publish](functions-develop-vs-code.md#publish-to-azure)<br/>&bull;&nbsp;[Visual Studio publish](functions-develop-vs.md#publish-to-azure)<br/>&bull;&nbsp;[Core Tools publish](functions-run-local.md#publish) | Deployments during development and other improvised deployments. Deploying your code on-demand using [local development tools](functions-develop-local.md#local-development-environments). |
21+
| Tools-based | &bull;&nbsp;[Azure CLI](/cli/azure/functionapp/deployment/source#az-functionapp-deployment-source-config-zip)<br/>&bull;&nbsp;[Visual&nbsp;Studio&nbsp;Code&nbsp;publish](functions-develop-vs-code.md#publish-to-azure)<br/>&bull;&nbsp;[Visual Studio publish](functions-develop-vs.md#publish-to-azure)<br/>&bull;&nbsp;[Core Tools publish](functions-run-local.md#publish) | Deployments during development and other improvised deployments. Deploying your code on-demand using [local development tools](functions-develop-local.md#local-development-environments). |
2222
| App Service-managed| &bull;&nbsp;[Deployment&nbsp;Center&nbsp;(CI/CD)](functions-continuous-deployment.md)<br/>&bull;&nbsp;[Container&nbsp;deployments](./functions-how-to-custom-container.md#enable-continuous-deployment-to-azure) | Continuous deployment (CI/CD) from source control or from a container registry. Deployments are managed by the App Service platform (Kudu).|
2323
| External pipelines|&bull;&nbsp;[Azure Pipelines](functions-how-to-azure-devops.md)<br/>&bull;&nbsp;[GitHub Actions](functions-how-to-github-actions.md) | Production pipelines that include validation, testing, and other actions that must be run as part of an automated deployment. Deployments are managed by the pipeline. |
2424

@@ -40,7 +40,7 @@ Each plan has different behaviors. Not all deployment technologies are available
4040

4141
| Deployment technology | Flex Consumption| Consumption | Elastic Premium | Dedicated | Container Apps |
4242
|-----------------------|:-------------------:|:-------------------------:|:------------------:|:---------------------------:|:-------------:|
43-
| [OneDeploy](#one-deploy) || | | | |
43+
| [One deploy](#one-deploy) || | | | |
4444
| [Zip deploy](#zip-deploy) | |||| |
4545
| [External package URL](#external-package-url)<sup>1</sup> | |||| |
4646
| [Docker container](#docker-container) | | Linux-only | Linux-only | Linux-only ||
@@ -127,7 +127,7 @@ Package-based deployment methods store the package in the storage account associ
127127
128128
## Deployment technology details
129129
130-
The following deployment methods are available in Azure Functions.
130+
The following deployment methods are available in Azure Functions. Refer to the [deployment technology availability](#deployment-technology-availability) table to determine which technologies each hosting plan supports.
131131
132132
### One deploy
133133
One deploy is the only deployment technology supported for apps on the Flex Consumption plan. The end result is a ready-to-run .zip package that your function app runs on.
@@ -145,7 +145,7 @@ One deploy is the only deployment technology supported for apps on the Flex Cons
145145
Zip deploy is the default and recommended deployment technology for function apps on the Consumption, Elastic Premium, and App Service (Dedicated) plans. The end result a ready-to-run .zip package that your function app runs on. It differs from [external package URL](#external-package-url) in that our platform is responsible for remote building and storing your app content.
146146
147147
>__How to use it:__ Deploy by using your favorite client tool: [Visual Studio Code](functions-develop-vs-code.md#publish-to-azure), [Visual Studio](functions-develop-vs.md#publish-to-azure), or from the command line using [Azure Functions Core Tools](functions-run-local.md#project-file-deployment) or the [Azure CLI](/cli/azure/functionapp/deployment/source#az-functionapp-deployment-source-config-zip). Our [Azure Dev Ops Task](functions-how-to-azure-devops.md#deploy-your-app-1) and [GitHub Action](functions-how-to-github-actions.md) similarly leverage zip deploy.
148-
148+
>
149149
>When you deploy by using zip deploy, you can set your app to [run from package](run-functions-from-deployment-package.md). To run from package, set the [`WEBSITE_RUN_FROM_PACKAGE`](functions-app-settings.md#website_run_from_package) application setting value to `1`. We recommend zip deployment. It yields faster loading times for your applications, and it's the default for VS Code, Visual Studio, and the Azure CLI.
150150
151151
>__When to use it:__ Zip deploy is the default and recommended deployment technology for function apps on the Windows Consumption, Windows and Linux Elastic Premium, and Windows and Linux App Service (Dedicated) plans.

articles/azure-functions/functions-how-to-azure-devops.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Continuously update function app code using Azure Pipelines
33
description: Learn how to use Azure Pipelines to set up a pipeline that builds and deploys apps to Azure Functions.
44
author: juliakm
55
ms.topic: conceptual
6-
ms.date: 09/27/2024
6+
ms.date: 11/07/2024
77
ms.author: jukullam
88
ms.custom: devx-track-csharp, devx-track-azurecli, devops-pipelines-deploy
99
ms.devlang: azurecli
@@ -20,6 +20,9 @@ You'll use the `AzureFunctionApp` task to deploy to Azure Functions. There are n
2020

2121
Choose your task version at the top of the article. YAML pipelines aren't available for Azure DevOps 2019 and earlier.
2222

23+
> [!NOTE]
24+
> The [AzureFunctionApp@2](/azure/devops/pipelines/tasks/reference/azure-function-app-v2) is highly recommended. Deploying to an app on the [Flex Consumption](./flex-consumption-plan.md) plan is only supported in version 2.
25+
2326
## Prerequisites
2427

2528
* An Azure DevOps organization. If you don't have one, you can [create one for free](/azure/devops/pipelines/get-started/pipelines-sign-up). If your team already has one, then make sure you're an administrator of the Azure DevOps project that you want to use.

articles/azure-functions/functions-how-to-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ Optional parameters for all function app plans:
315315
316316
Keep the following considerations in mind when using the Azure Functions action:
317317
318-
+ When using GitHub Actions, the code is deployed to your function app using [Zip deployment for Azure Functions](deployment-zip-push.md).
318+
+ When using GitHub Actions, the code is deployed using [one deploy](./functions-deployment-technologies.md#one-deploy) to apps on the [Flex Consumption](./flex-consumption-plan.md) plan and [zip deploy](deployment-zip-push.md) to apps on the [Consumption](./consumption-plan.md), [Elastic Premium](./functions-premium-plan.md), and [Dedicated (App Service)](./dedicated-plan.md) plans. The exception is Linux Consumption, where [external package URL](./functions-deployment-technologies.md#external-package-url) is used.
319319
320320
+ The credentials required by GitHub to connection to Azure for deployment are stored as Secrets in your GitHub repository and accessed in the deployment as `secrets.<SECRET_NAME>`.
321321

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ For more information, see [this announcement](https://github.com/Azure/app-servi
2828

2929
## Enable functions to run from a package
3030

31-
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:
31+
Function apps on the [Flex Consumption](./flex-consumption-plan) hosting plan run from a package by default. No special configuration needs to be done.
32+
33+
To enable your function app to run from a package on the [Consumption](./consumption-plan.md), [Elastic Premium](./functions-premium-plan.md), and [Dedicated (App Service)](./dedicated-plan.md) hosting plans, 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:
3234

3335
| Value | Description |
3436
|---------|---------|
@@ -45,6 +47,7 @@ The following table indicates the recommended `WEBSITE_RUN_FROM_PACKAGE` values
4547

4648
## General considerations
4749

50+
+ Do not add the `WEBSITE_RUN_FROM_PACKAGE` app setting to apps on the [Flex Consumption](./flex-consumption-plan.md) plan.
4851
+ The package file must be .zip formatted. Tar and gzip formats aren't supported.
4952
+ [Zip deployment](#integration-with-zip-deployment) is recommended.
5053
+ When deploying your function app to Windows, you should set `WEBSITE_RUN_FROM_PACKAGE` to `1` and publish with zip deployment.
@@ -87,10 +90,11 @@ When you set the `WEBSITE_RUN_FROM_PACKAGE` app setting value to `1`, the zip de
8790
8891
## Use WEBSITE_RUN_FROM_PACKAGE = URL
8992

90-
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.
93+
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. This option is not supported in the [Flex Consumption](./flex-consumption-plan.md) plan.
9194

9295
### Considerations for deploying from a URL
9396

97+
+ Do not set `WEBSITE_RUN_FROM_PACKAGE = <URL>` in apps on the [Flex Consumption](./flex-consumption-plan.md) plan. This option is not supported.
9498
+ 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>`.
9599
+ When you specify a URL, you must also [manually sync triggers](functions-deployment-technologies.md#trigger-syncing) after you publish an updated package.
96100
+ The Functions runtime must have permissions to access the package URL.

0 commit comments

Comments
 (0)