You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-functions/deployment-zip-push.md
+31-19Lines changed: 31 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,68 +4,71 @@ description: Use the .zip file deployment facilities of the Kudu deployment serv
4
4
services: functions
5
5
documentationcenter: na
6
6
author: ggailey777
7
-
manager: cfowler
7
+
manager: jeconnoc
8
8
editor: ''
9
9
tags: ''
10
10
11
11
ms.service: functions
12
12
ms.devlang: multiple
13
-
ms.topic: article
13
+
ms.topic: conceptual
14
14
ms.tgt_pltfrm: multiple
15
15
ms.workload: na
16
-
ms.date: 05/29/2018
16
+
ms.date: 08/12/2018
17
17
ms.author: glenga
18
18
19
19
---
20
-
# Zip push deployment for Azure Functions
21
-
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.
22
20
23
-
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).
21
+
# Zip deployment for Azure Functions
24
22
25
-
For faster iteration during development, it's often easier to deploy your function app project files directly from a compressed .zip file. This .zip file deployment uses the same Kudu service that powers continuous integration-based deployments, including:
23
+
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.
24
+
25
+
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).
26
+
27
+
To speed development, you may find it easier to deploy your function app project files directly from a .zip file. The .zip deployment API takes the contents of a .zip file and extracts the contents into the `wwwroot` folder of your function app. This .zip file deployment uses the same Kudu service that powers continuous integration-based deployments, including:
26
28
27
29
+ Deletion of files that were left over from earlier deployments.
28
30
+ Deployment customization, including running deployment scripts.
29
31
+ Deployment logs.
30
32
+ Syncing function triggers in a [Consumption plan](functions-scale.md) function app.
31
33
32
-
For more information, see the [.zip push deployment reference](https://github.com/projectkudu/kudu/wiki/Deploying-from-a-zip-file).
34
+
For more information, see the [.zip deployment reference](https://github.com/projectkudu/kudu/wiki/Deploying-from-a-zip-file).
33
35
34
36
## Deployment .zip file requirements
35
-
The .zip file that you use for push deployment must contain all of the project files in your function app, including your function code.
37
+
38
+
The .zip file that you use for push deployment must contain all of the files needed to run your function.
36
39
37
40
>[!IMPORTANT]
38
-
> When you use .zip push deployment, any files from an existing deployment that aren't found in the .zip file are deleted from your function app.
41
+
> When you use .zip deployment, any files from an existing deployment that aren't found in the .zip file are deleted from your function app.
A function app includes all of the files and folders in the `wwwroot` directory. A .zip file deployment includes the contents of the `wwwroot` directory, but not the directory itself.
45
+
A function app includes all of the files and folders in the `wwwroot` directory. A .zip file deployment includes the contents of the `wwwroot` directory, but not the directory itself. When deploying a C# class library project, you must include the compiled library files and dependencies in a `bin` subfolder in your .zip package.
43
46
44
47
## Download your function app files
45
48
46
-
When you are developing on a local computer, it's easy to create a .zip file of the function app project folder on your development computer.
49
+
When you are developing on a local computer, it's easy to create a .zip file of the function app project folder on your development computer.
47
50
48
-
However, you might have created your functions by using the editor in the Azure portal. You can download an existing function app project in one of these ways:
51
+
However, you might have created your functions by using the editor in the Azure portal. You can download an existing function app project in one of these ways:
49
52
50
-
+**From the Azure portal:**
53
+
+**From the Azure portal:**
51
54
52
55
1. Sign in to the [Azure portal](https://portal.azure.com), and then go to your function app.
53
56
54
-
2. On the **Overview** tab, select **Download app content**. Select your download options, and then select **Download**.
57
+
2. On the **Overview** tab, select **Download app content**. Select your download options, and then select **Download**.
55
58
56
59
57
60
58
61
The downloaded .zip file is in the correct format to be republished to your function app by using .zip push deployment. The portal download can also add the files needed to open your function app directly in Visual Studio.
59
62
60
-
+**Using REST APIs:**
63
+
+**Using REST APIs:**
61
64
62
65
Use the following deployment GET API to download the files from your `<function_app>` project:
Including `/site/wwwroot/` makes sure your zip file includes only the function app project files and not the entire site. If you are not already signed in to Azure, you will be asked to do so. Note that sending a POST request to the `api/zip/` API is discoraged in favor of the zip deployment method described in this topic.
69
+
Including `/site/wwwroot/` makes sure your zip file includes only the function app project files and not the entire site. If you are not already signed in to Azure, you will be asked to do so.
67
70
68
-
You can also download a .zip file from a GitHub repository. Keep in mind that when you download a GitHub repository as a .zip file, GitHub adds an extra folder level for the branch. This extra folder level means that you can't deploy the .zip file directly as you downloaded it from GitHub. If you're using a GitHub repository to maintain your function app, you should use [continuous integration](functions-continuous-deployment.md) to deploy your app.
71
+
You can also download a .zip file from a GitHub repository. When you download a GitHub repository as a .zip file, GitHub adds an extra folder level for the branch. This extra folder level means that you can't deploy the .zip file directly as you downloaded it from GitHub. If you're using a GitHub repository to maintain your function app, you should use [continuous integration](functions-continuous-deployment.md) to deploy your app.
69
72
70
73
## <aname="cli"></a>Deploy by using Azure CLI
71
74
@@ -77,13 +80,22 @@ In the following command, replace the `<zip_file_path>` placeholder with the pat
77
80
az functionapp deployment source config-zip -g myResourceGroup -n \
78
81
<app_name> --src <zip_file_path>
79
82
```
83
+
80
84
This command deploys project files from the downloaded .zip file to your function app in Azure. It then restarts the app. To view the list of deployments for this function app, you must use the REST APIs.
81
85
82
86
When you're using Azure CLI on your local computer, `<zip_file_path>` is the path to the .zip file on your computer. You can also run Azure CLI in [Azure Cloud Shell](../cloud-shell/overview.md). When you use Cloud Shell, you must first upload your deployment .zip file to the Azure Files account that's associated with your Cloud Shell. In that case, `<zip_file_path>` is the storage location that your Cloud Shell account uses. For more information, see [Persist files in Azure Cloud Shell](../cloud-shell/persisting-shell-storage.md).
You can also choose to run your functions directly from the deployment package file. This method skips the deployment step of copying files from the package to the `wwwroot` directory of your function app. Instead, the package file is mounted by the Functions runtime, and the contents of the `wwwroot` directory become read-only.
93
+
94
+
> [!NOTE]
95
+
> The ability to run your function app from the deployment package is in preview.
96
+
97
+
Zip deployment integrates with this feature, which you can enable by setting the function app setting `WEBSITE_RUN_FROM_ZIP` to a value of `1`. For more information, see [Run your functions from a deployment package file](run-functions-from-deployment-package.md).
description: Reference documentation for the Azure Functions app settings or environment variables.
4
4
services: functions
5
5
author: ggailey777
6
-
manager: cfowler
6
+
manager: jeconnoc
7
7
editor: ''
8
8
tags: ''
9
9
keywords:
@@ -12,14 +12,16 @@ ms.devlang: multiple
12
12
ms.topic: article
13
13
ms.tgt_pltfrm: multiple
14
14
ms.workload: na
15
-
ms.date: 09/26/2017
15
+
ms.date: 08/22/2018
16
16
ms.author: glenga
17
17
---
18
18
19
19
# App settings reference for Azure Functions
20
20
21
21
App settings in a function app contain global configuration options that affect all functions for that function app. When you run locally, these settings are in environment variables. This article lists the app settings that are available in function apps.
There are other global configuration options in the [host.json](functions-host-json.md) file and in the [local.settings.json](functions-run-local.md#local-settings-file) file.
24
26
25
27
## APPINSIGHTS_INSTRUMENTATIONKEY
@@ -122,7 +124,7 @@ For consumption plans only. Connection string for storage account where the func
For consumption plans only. The file path to the function app code and configuration. Used with WEBSITE_CONTENTAZUREFILECONNECTIONSTRING. Default is a unique string that begins with the function app name. See [Create a function app](functions-infrastructure-as-code.md#create-a-function-app).
128
130
@@ -149,6 +151,19 @@ Default is "6.5.0".
149
151
|---|------------|
150
152
|WEBSITE\_NODE\_DEFAULT_VERSION|6.5.0|
151
153
154
+
## WEBSITE\_RUN\_FROM\_ZIP
155
+
156
+
Enables your function app to run from a mounted package file.
157
+
158
+
> [!NOTE]
159
+
> This setting is for a preview feature.
160
+
161
+
|Key|Sample value|
162
+
|---|------------|
163
+
|WEBSITE\_RUN\_FROM\_ZIP|1|
164
+
165
+
Valid values are either a URL that resolves to the location of a deployment package file, or `1`. When set to `1`, the package must be in the `d:\home\data\SitePackages` folder. When using zip deployment with this setting, the package is automatically uploaded to this location. For more information, see [Run your functions from a package file](run-functions-from-deployment-package.md).
166
+
152
167
## Next steps
153
168
154
169
[Learn how to update app settings](functions-how-to-use-azure-function-app-settings.md#manage-app-service-settings)
title: Run your Azure Functions from a package | Microsoft Docs
3
+
description: Have the Azure Functions runtime run your functions by mounting a deployment package file that contains your function app project files.
4
+
services: functions
5
+
documentationcenter: na
6
+
author: ggailey777
7
+
manager: jeconnoc
8
+
editor: ''
9
+
tags: ''
10
+
11
+
ms.service: functions
12
+
ms.devlang: multiple
13
+
ms.topic: conceptual
14
+
ms.workload: na
15
+
ms.date: 08/22/2018
16
+
ms.author: glenga
17
+
18
+
---
19
+
20
+
# Run your Azure Functions from a package file
21
+
22
+
> [!NOTE]
23
+
> The functionality described in this article is currently in preview; it is not available for Functions on Linux.
24
+
25
+
In Azure, you can run your functions directly from a deployment package file in your function app. The other option is to deploy your function project files in the `d:\home\site\wwwroot` directory of your function app.
26
+
27
+
This article describes the benefits of running your functions from a package. It also shows how to enable this functionality in your function app.
28
+
29
+
## Benefits of running from a package file
30
+
31
+
There are several benefits to running from a package file:
32
+
33
+
+ Reduces the risk of file copy locking issues.
34
+
+ Can be deployed to a production app (with restart).
35
+
+ You can be certain of the files that are running in your app.
36
+
+ Improves the performance of [Azure Resource Manager deployments](functions-infrastructure-as-code.md).
37
+
+ May reduce the cold-start time of JavaScript functions.
38
+
39
+
For more information, see [this announcement](https://github.com/Azure/app-service-announcements/issues/84).
40
+
41
+
## Enabling functions to run from a package
42
+
43
+
To enable your function app to run from a package, you just add a `WEBSITE_RUN_FROM_ZIP` setting to your function app settings. The `WEBSITE_RUN_FROM_ZIP` setting can have one of the following values:
44
+
45
+
| Value | Description |
46
+
|---------|---------|
47
+
|**`<url>`**| Location of a specific package file you want to run. When using Blob storage, you should use a private container with a [Shared Access Signature (SAS)](../vs-azure-tools-storage-manage-with-storage-explorer.md#attach-a-storage-account-by-using-a-shared-access-signature-sas) to enable the Functions runtime to access to the package. You can use the [Azure Storage Explorer](https://azure.microsoft.com/features/storage-explorer/) to upload package files to your Blob storage account. |
48
+
|**`1`**| Run from a package file in the `d:\home\data\SitePackages` folder of your function app. This option requires the folder to also have a file named `packagename.txt`. This file contains only the name of the package file in folder, without any whitespace. |
49
+
50
+
The following shows a function app configured to run from a .zip file hosted in Azure Blob storage:
> Currently, only .zip package files are supported.
56
+
57
+
## Integration with zip deployment
58
+
59
+
[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 `d:\home\data\SitePackages` folder. With the `WEBSITE_RUN_FROM_ZIP` app setting value of `1`, the zip deployment APIs copy your package to the `d:\home\data\SitePackages` folder instead of extracting the files to `d:\home\site\wwwroot`. It also creates the `packagename.txt` file. The function app is then run from the package after a restart, and `wwwroot` becomes read-only. For more information about zip deployment, see [Zip deployment for Azure Functions](deployment-zip-push.md).
Copy file name to clipboardExpand all lines: includes/app-service-deploy-zip-push-rest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The following example uses the cURL tool to deploy a .zip file. Replace the plac
12
12
curl -X POST -u <deployment_user> --data-binary @"<zip_file_path>" https://<app_name>.scm.azurewebsites.net/api/zipdeploy
13
13
```
14
14
15
-
This request triggers push deployment from the uploaded .zip file. You can review the current and past deployments by using the https://<app_name>.scm.azurewebsites.net/api/deployments endpoint, as shown in the following cURL example. Again, replace `<app_name>` with the name of your app and `<deployment_user>` with the username of your deployment credentials.
15
+
This request triggers push deployment from the uploaded .zip file. You can review the current and past deployments by using the `https://<app_name>.scm.azurewebsites.net/api/deployments` endpoint, as shown in the following cURL example. Again, replace `<app_name>` with the name of your app and `<deployment_user>` with the username of your deployment credentials.
Copy file name to clipboardExpand all lines: includes/functions-folder-structure.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,17 @@
1
+
---
2
+
title: include file
3
+
description: include file
4
+
services: functions
5
+
author: ggailey777
6
+
manager: jeconnoc
7
+
ms.service: functions
8
+
ms.topic: include
9
+
ms.date: 08/12/2018
10
+
ms.author: glenga
11
+
ms.custom: include file
12
+
---
1
13
2
-
The code for all the functions in a specific function app is located in a root folder that contains a host configuration file and one or more subfolders. Each subfolder contains the code for a separate function, as in the following example:
14
+
The code for all the functions in a specific function app is located in a root folder (`wwwroot`) that contains a host configuration file and one or more subfolders. Each subfolder contains the code for a separate function, as in the following example:
3
15
4
16
```
5
17
wwwroot
@@ -13,9 +25,11 @@ wwwroot
13
25
| - mycsharpfunction
14
26
| | - function.json
15
27
| | - run.csx
28
+
| - bin
29
+
| | - mycompiledcsharp.dll
16
30
```
17
31
18
32
The host.json file contains some runtime-specific configurations, and sits in the root folder of the function app. For information about settings that are available, see the [host.json reference](../articles/azure-functions/functions-host-json.md).
19
33
20
-
Each function has a folder that contains one or more code files, the function.json configuration, and other dependencies.
34
+
Each function has a folder that contains one or more code files, the function.json configuration, and other dependencies. For a C# class library project, the compiled class library (.dll) file is deployed to the `bin` subfolder.
0 commit comments