Skip to content

Commit dbad524

Browse files
authored
Merge pull request #69340 from ggailey777/stegriff
Updates to the local settings table
2 parents 2e0a449 + 9fcbf31 commit dbad524

File tree

3 files changed

+30
-26
lines changed

3 files changed

+30
-26
lines changed

articles/azure-functions/functions-app-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The version of the Functions runtime to use in this function app. A tilde with m
117117

118118
## FUNCTIONS\_WORKER\_RUNTIME
119119

120-
The language worker runtime to load in the function app. This will correspond to the language being used in your application (for example, "dotnet"). For functions in multiple languages you will need to publish them to multiple apps, each with a corresponding worker runtime value. Valid values are `dotnet` (C#/F#), `node` (JavaScript), and `java` (Java).
120+
The language worker runtime to load in the function app. This will correspond to the language being used in your application (for example, "dotnet"). For functions in multiple languages you will need to publish them to multiple apps, each with a corresponding worker runtime value. Valid values are `dotnet` (C#/F#), `node` (JavaScript/TypeScript), `java` (Java), and `python` (Python).
121121

122122
|Key|Sample value|
123123
|---|------------|

articles/azure-functions/functions-run-local.experimental.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.assetid: 242736be-ec66-4114-924b-31795fd18884
1010
ms.service: azure-functions
1111
ms.devlang: multiple
1212
ms.topic: conceptual
13-
ms.date: 10/29/2018
13+
ms.date: 03/13/2019
1414
ms.author: glenga
1515
experimental: false
1616
experiment_id: c80d19c3-428d-4b
@@ -192,22 +192,22 @@ The file local.settings.json stores app settings, connection strings, and settin
192192

193193
| Setting | Description |
194194
| ------------ | -------------------------------------- |
195-
| **IsEncrypted** | When set to **true**, all values are encrypted using a local machine key. Used with `func settings` commands. Default value is **false**. |
196-
| **Values** | Collection of application settings and connection strings used when running locally. These values correspond to app settings in your function app in Azure, such as **AzureWebJobsStorage** and **AzureWebJobsDashboard**. Many triggers and bindings have a property that refers to a connection string app setting, such as **Connection** for the [Blob storage trigger](functions-bindings-storage-blob.md#trigger---configuration). For such properties, you need an application setting defined in the **Values** array. <br/>**AzureWebJobsStorage** is a required app setting for triggers other than HTTP. When you have the [Azure storage emulator](../storage/common/storage-use-emulator.md) installed locally, you can set **AzureWebJobsStorage** to `UseDevelopmentStorage=true` and Core Tools uses the emulator. This is useful during development, but you should test with an actual storage connection before deployment. |
197-
| **Host** | Settings in this section customize the Functions host process when running locally. |
198-
| **LocalHttpPort** | Sets the default port used when running the local Functions host (`func host start` and `func run`). The `--port` command-line option takes precedence over this value. |
199-
| **CORS** | Defines the origins allowed for [cross-origin resource sharing (CORS)](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). Origins are supplied as a comma-separated list with no spaces. The wildcard value (\*) is supported, which allows requests from any origin. |
200-
| **ConnectionStrings** | Do not use this collection for the connection strings used by your function bindings. This collection is only used by frameworks that typically get connection strings from the **ConnectionStrings** section of a configuration file, such as [Entity Framework](https://msdn.microsoft.com/library/aa937723(v=vs.113).aspx). Connection strings in this object are added to the environment with the provider type of [System.Data.SqlClient](https://msdn.microsoft.com/library/system.data.sqlclient(v=vs.110).aspx). Items in this collection are not published to Azure with other app settings. You must explicitly add these values to the **Connection strings** collection of your function app settings. If you are creating a [SqlConnection](https://msdn.microsoft.com/library/system.data.sqlclient.sqlconnection(v=vs.110).aspx) in your function code, you should store the connection string value in **Application settings** with your other connections. |
195+
| **`IsEncrypted`** | When set to `true`, all values are encrypted using a local machine key. Used with `func settings` commands. Default value is `false`. |
196+
| **`Values`** | Collection of application settings and connection strings used when running locally. These values correspond to app settings in your function app in Azure, such as [`AzureWebJobsStorage`]. Many triggers and bindings have a property that refers to a connection string app setting, such as `Connection` for the [Blob storage trigger](functions-bindings-storage-blob.md#trigger---configuration). For such properties, you need an application setting defined in the `Values` array. <br/>[`AzureWebJobsStorage`] is a required app setting for triggers other than HTTP. <br/>Version 2.x of the Functions runtime requires the [`FUNCTIONS_WORKER_RUNTIME`] setting, which is generated for your project by Core Tools. <br/> When you have the [Azure storage emulator](../storage/common/storage-use-emulator.md) installed locally, you can set [`AzureWebJobsStorage`] to `UseDevelopmentStorage=true` and Core Tools uses the emulator. This is useful during development, but you should test with an actual storage connection before deployment. |
197+
| **`Host`** | Settings in this section customize the Functions host process when running locally. |
198+
| **`LocalHttpPort`** | Sets the default port used when running the local Functions host (`func host start` and `func run`). The `--port` command-line option takes precedence over this value. |
199+
| **`CORS`** | Defines the origins allowed for [cross-origin resource sharing (CORS)](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). Origins are supplied as a comma-separated list with no spaces. The wildcard value (\*) is supported, which allows requests from any origin. |
200+
| **`ConnectionStrings`** | Do not use this collection for the connection strings used by your function bindings. This collection is only used by frameworks that typically get connection strings from the `ConnectionStrings` section of a configuration file, such as [Entity Framework](https://msdn.microsoft.com/library/aa937723(v=vs.113).aspx). Connection strings in this object are added to the environment with the provider type of [System.Data.SqlClient](https://msdn.microsoft.com/library/system.data.sqlclient(v=vs.110).aspx). Items in this collection are not published to Azure with other app settings. You must explicitly add these values to the `Connection strings` collection of your function app settings. If you are creating a [`SqlConnection`](https://msdn.microsoft.com/library/system.data.sqlclient.sqlconnection(v=vs.110).aspx) in your function code, you should store the connection string value in **Application Settings** in the portal with your other connections. |
201201

202202
The function app settings values can also be read in your code as environment variables. For more information, see the Environment variables section of these language-specific reference topics:
203203

204-
+ [C# precompiled](functions-dotnet-class-library.md#environment-variables)
205-
+ [C# script (.csx)](functions-reference-csharp.md#environment-variables)
206-
+ [F# script (.fsx)](functions-reference-fsharp.md#environment-variables)
207-
+ [Java](functions-reference-java.md#environment-variables)
208-
+ [JavaScript](functions-reference-node.md#environment-variables)
204+
* [C# precompiled](functions-dotnet-class-library.md#environment-variables)
205+
* [C# script (.csx)](functions-reference-csharp.md#environment-variables)
206+
* [F# script (.fsx)](functions-reference-fsharp.md#environment-variables)
207+
* [Java](functions-reference-java.md#environment-variables)
208+
* [JavaScript](functions-reference-node.md#environment-variables)
209209

210-
When no valid storage connection string is set for **AzureWebJobsStorage** and the emulator isn't being used, the following error message is shown:
210+
When no valid storage connection string is set for [`AzureWebJobsStorage`] and the emulator isn't being used, the following error message is shown:
211211
212212
> Missing value for AzureWebJobsStorage in local.settings.json. This is required for all triggers other than HTTP. You can run 'func azure functionapp fetch-app-settings \<functionAppName\>' or specify a connection string in local.settings.json.
213213
@@ -490,3 +490,5 @@ To file a bug or feature request, [open a GitHub issue](https://github.com/azure
490490
[Azure Functions Core Tools]: https://www.npmjs.com/package/azure-functions-core-tools
491491
[Azure portal]: https://portal.azure.com
492492
[Node.js]: https://docs.npmjs.com/getting-started/installing-node#osx-or-windows
493+
[`FUNCTIONS_WORKER_RUNTIME`]: functions-app-settings.md#functionsworkerruntime
494+
[`AzureWebJobsStorage`]: functions-app-settings.md#azurewebjobsstorage

articles/azure-functions/functions-run-local.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -181,22 +181,22 @@ The file local.settings.json stores app settings, connection strings, and settin
181181

182182
| Setting | Description |
183183
| ------------ | -------------------------------------- |
184-
| **IsEncrypted** | When set to **true**, all values are encrypted using a local machine key. Used with `func settings` commands. Default value is **false**. |
185-
| **Values** | Collection of application settings and connection strings used when running locally. These values correspond to app settings in your function app in Azure, such as **AzureWebJobsStorage** and **AzureWebJobsDashboard**. Many triggers and bindings have a property that refers to a connection string app setting, such as **Connection** for the [Blob storage trigger](functions-bindings-storage-blob.md#trigger---configuration). For such properties, you need an application setting defined in the **Values** array. <br/>**AzureWebJobsStorage** is a required app setting for triggers other than HTTP. When you have the [Azure storage emulator](../storage/common/storage-use-emulator.md) installed locally, you can set **AzureWebJobsStorage** to `UseDevelopmentStorage=true` and Core Tools uses the emulator. This is useful during development, but you should test with an actual storage connection before deployment. |
186-
| **Host** | Settings in this section customize the Functions host process when running locally. |
187-
| **LocalHttpPort** | Sets the default port used when running the local Functions host (`func host start` and `func run`). The `--port` command-line option takes precedence over this value. |
188-
| **CORS** | Defines the origins allowed for [cross-origin resource sharing (CORS)](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). Origins are supplied as a comma-separated list with no spaces. The wildcard value (\*) is supported, which allows requests from any origin. |
189-
| **ConnectionStrings** | Do not use this collection for the connection strings used by your function bindings. This collection is only used by frameworks that typically get connection strings from the **ConnectionStrings** section of a configuration file, such as [Entity Framework](https://msdn.microsoft.com/library/aa937723(v=vs.113).aspx). Connection strings in this object are added to the environment with the provider type of [System.Data.SqlClient](https://msdn.microsoft.com/library/system.data.sqlclient(v=vs.110).aspx). Items in this collection are not published to Azure with other app settings. You must explicitly add these values to the **Connection strings** collection of your function app settings. If you are creating a [SqlConnection](https://msdn.microsoft.com/library/system.data.sqlclient.sqlconnection(v=vs.110).aspx) in your function code, you should store the connection string value in **Application settings** with your other connections. |
184+
| **`IsEncrypted`** | When set to `true`, all values are encrypted using a local machine key. Used with `func settings` commands. Default value is `false`. |
185+
| **`Values`** | Collection of application settings and connection strings used when running locally. These values correspond to app settings in your function app in Azure, such as [`AzureWebJobsStorage`]. Many triggers and bindings have a property that refers to a connection string app setting, such as `Connection` for the [Blob storage trigger](functions-bindings-storage-blob.md#trigger---configuration). For such properties, you need an application setting defined in the `Values` array. <br/>[`AzureWebJobsStorage`] is a required app setting for triggers other than HTTP. <br/>Version 2.x of the Functions runtime requires the [`FUNCTIONS_WORKER_RUNTIME`] setting, which is generated for your project by Core Tools. <br/> When you have the [Azure storage emulator](../storage/common/storage-use-emulator.md) installed locally, you can set [`AzureWebJobsStorage`] to `UseDevelopmentStorage=true` and Core Tools uses the emulator. This is useful during development, but you should test with an actual storage connection before deployment. |
186+
| **`Host`** | Settings in this section customize the Functions host process when running locally. |
187+
| **`LocalHttpPort`** | Sets the default port used when running the local Functions host (`func host start` and `func run`). The `--port` command-line option takes precedence over this value. |
188+
| **`CORS`** | Defines the origins allowed for [cross-origin resource sharing (CORS)](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). Origins are supplied as a comma-separated list with no spaces. The wildcard value (\*) is supported, which allows requests from any origin. |
189+
| **`ConnectionStrings`** | Do not use this collection for the connection strings used by your function bindings. This collection is only used by frameworks that typically get connection strings from the `ConnectionStrings` section of a configuration file, such as [Entity Framework](https://msdn.microsoft.com/library/aa937723(v=vs.113).aspx). Connection strings in this object are added to the environment with the provider type of [System.Data.SqlClient](https://msdn.microsoft.com/library/system.data.sqlclient(v=vs.110).aspx). Items in this collection are not published to Azure with other app settings. You must explicitly add these values to the `Connection strings` collection of your function app settings. If you are creating a [`SqlConnection`](https://msdn.microsoft.com/library/system.data.sqlclient.sqlconnection(v=vs.110).aspx) in your function code, you should store the connection string value in **Application Settings** in the portal with your other connections. |
190190

191191
The function app settings values can also be read in your code as environment variables. For more information, see the Environment variables section of these language-specific reference topics:
192192

193-
+ [C# precompiled](functions-dotnet-class-library.md#environment-variables)
194-
+ [C# script (.csx)](functions-reference-csharp.md#environment-variables)
195-
+ [F# script (.fsx)](functions-reference-fsharp.md#environment-variables)
196-
+ [Java](functions-reference-java.md#environment-variables)
197-
+ [JavaScript](functions-reference-node.md#environment-variables)
193+
* [C# precompiled](functions-dotnet-class-library.md#environment-variables)
194+
* [C# script (.csx)](functions-reference-csharp.md#environment-variables)
195+
* [F# script (.fsx)](functions-reference-fsharp.md#environment-variables)
196+
* [Java](functions-reference-java.md#environment-variables)
197+
* [JavaScript](functions-reference-node.md#environment-variables)
198198

199-
When no valid storage connection string is set for **AzureWebJobsStorage** and the emulator isn't being used, the following error message is shown:
199+
When no valid storage connection string is set for [`AzureWebJobsStorage`] and the emulator isn't being used, the following error message is shown:
200200
201201
> Missing value for AzureWebJobsStorage in local.settings.json. This is required for all triggers other than HTTP. You can run 'func azure functionapp fetch-app-settings \<functionAppName\>' or specify a connection string in local.settings.json.
202202
@@ -479,3 +479,5 @@ To file a bug or feature request, [open a GitHub issue](https://github.com/azure
479479
[Azure Functions Core Tools]: https://www.npmjs.com/package/azure-functions-core-tools
480480
[Azure portal]: https://portal.azure.com
481481
[Node.js]: https://docs.npmjs.com/getting-started/installing-node#osx-or-windows
482+
[`FUNCTIONS_WORKER_RUNTIME`]: functions-app-settings.md#functionsworkerruntime
483+
[`AzureWebJobsStorage`]: functions-app-settings.md#azurewebjobsstorage

0 commit comments

Comments
 (0)