Skip to content

Commit 5c80662

Browse files
author
Jill Grant
authored
Merge pull request #267370 from lilyjma/updateBundles
Update docs to reference bundles v4
2 parents 8b94469 + f1cf645 commit 5c80662

File tree

5 files changed

+32
-15
lines changed

5 files changed

+32
-15
lines changed

articles/azure-functions/functions-bindings-register.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The following table lists the currently available version ranges of the default
4545

4646

4747
> [!NOTE]
48-
> Even though host.json supports custom ranges for `version`, you should use a version range value from this table, such as `[3.3.0, 4.0.0)`.
48+
> Even though host.json supports custom ranges for `version`, you should use a version range value from this table, such as `[4.0.0, 5.0.0)`.
4949
5050
## Explicitly install extensions
5151

articles/azure-functions/functions-host-json.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following sample *host.json* file for version 2.x+ has all possible options
5252
},
5353
"extensionBundle": {
5454
"id": "Microsoft.Azure.Functions.ExtensionBundle",
55-
"version": "[1.*, 2.0.0)"
55+
"version": "[4.0.0, 5.0.0)"
5656
},
5757
"functions": [ "QueueProcessor", "GitHubWebHook" ],
5858
"functionTimeout": "00:05:00",
@@ -213,13 +213,13 @@ For more information on snapshots, see [Debug snapshots on exceptions in .NET ap
213213
| maximumCollectionPlanSize | 50 | The maximum number of problems that we can track at any time in a range from one to 9999. |
214214
| maximumSnapshotsRequired | 3 | The maximum number of snapshots collected for a single problem, in a range from one to 999. A problem may be thought of as an individual throw statement in your application. Once the number of snapshots collected for a problem reaches this value, no more snapshots will be collected for that problem until problem counters are reset (see `problemCounterResetInterval`) and the `thresholdForSnapshotting` limit is reached again. |
215215
| problemCounterResetInterval | 24:00:00 | How often to reset the problem counters in a range from one minute to seven days. When this interval is reached, all problem counts are reset to zero. Existing problems that have already reached the threshold for doing snapshots, but haven't yet generated the number of snapshots in `maximumSnapshotsRequired`, remain active. |
216-
| provideAnonymousTelemetry | true | Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger. It is also used to monitor usage patterns. |
216+
| provideAnonymousTelemetry | true | Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger. It's also used to monitor usage patterns. |
217217
| reconnectInterval | 00:15:00 | How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day. |
218218
| shadowCopyFolder | null | Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP. |
219219
| shareUploaderProcess | true | If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple. |
220220
| snapshotInLowPriorityThread | true | Determines whether or not to process snapshots in a low IO priority thread. Creating a snapshot is a fast operation but, in order to upload a snapshot to the Snapshot Debugger service, it must first be written to disk as a minidump. That happens in the SnapshotUploader process. Setting this value to true uses low-priority IO to write the minidump, which won't compete with your application for resources. Setting this value to false speeds up minidump creation at the expense of slowing down your application. |
221221
| snapshotsPerDayLimit | 30 | The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side. Uploads are rate limited to 50 per day per application (that is, per instrumentation key). This value helps prevent creating additional snapshots that will eventually be rejected during upload. A value of zero removes the limit entirely, which isn't recommended. |
222-
| snapshotsPerTenMinutesLimit | 1 | The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application. Creating a snapshot is fast, but creating a minidump of the snapshot and uploading it to the Snapshot Debugger service is a much slower operation that will compete with your application for resources (both CPU and I/O). |
222+
| snapshotsPerTenMinutesLimit | 1 | The maximum number of snapshots allowed in 10 minutes. Although there's no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application. Creating a snapshot is fast, but creating a minidump of the snapshot and uploading it to the Snapshot Debugger service is a much slower operation that will compete with your application for resources (both CPU and I/O). |
223223
| tempFolder | null | Specifies the folder to write minidumps and uploader log files. If not set, then *%TEMP%\Dumps* is used. |
224224
| thresholdForSnapshotting | 1 | How many times Application Insights needs to see an exception before it asks for snapshots. |
225225
| uploaderProxy | null | Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings. However, the Snapshot Uploader runs as a separate process and you may need to configure the proxy server manually. If this value is null, then Snapshot Collector will attempt to autodetect the proxy's address by examining `System.Net.WebRequest.DefaultWebProxy` and passing on the value to the Snapshot Uploader. If this value isn't null, then autodetection isn't used and the proxy server specified here will be used in the Snapshot Uploader. |
@@ -247,7 +247,7 @@ This setting is a child of [logging](#logging). It controls the console logging
247247

248248
|Property |Default | Description |
249249
|---------|---------|---------|
250-
|DisableColors|false| Suppresses log formatting in the container logs on Linux. Set to true if you are seeing unwanted ANSI control characters in the container logs when running on Linux. |
250+
|DisableColors|false| Suppresses log formatting in the container logs on Linux. Set to true if you're seeing unwanted ANSI control characters in the container logs when running on Linux. |
251251
|isEnabled|false|Enables or disables console logging.|
252252

253253
## Azure Cosmos DB
@@ -271,8 +271,8 @@ Configuration settings for a custom handler. For more information, see [Azure Fu
271271

272272
|Property | Default | Description |
273273
| --------- | --------- | --------- |
274-
| defaultExecutablePath | n/a | The executable to start as the custom handler process. It is a required setting when using custom handlers and its value is relative to the function app root. |
275-
| workingDirectory | *function app root* | The working directory in which to start the custom handler process. It is an optional setting and its value is relative to the function app root. |
274+
| defaultExecutablePath | n/a | The executable to start as the custom handler process. It's a required setting when using custom handlers and its value is relative to the function app root. |
275+
| workingDirectory | *function app root* | The working directory in which to start the custom handler process. It's an optional setting and its value is relative to the function app root. |
276276
| arguments | n/a | An array of command line arguments to pass to the custom handler process. |
277277
| enableForwardingHttpRequest | false | If set, all functions that consist of only an HTTP trigger and HTTP output is forwarded the original HTTP request instead of the custom handler [request payload](functions-custom-handlers.md#request-payload). |
278278

@@ -391,7 +391,7 @@ Controls the logging behaviors of the function app, including Application Insigh
391391

392392
|Property |Default | Description |
393393
|---------|---------|---------|
394-
|fileLoggingMode|debugOnly|Determines the file logging behavior when running in Azure. Options are `never`, `always`, and `debugOnly`. This setting isn't used when running locally. When possible, you should use Application Insights when debugging your functions in Azure. Using `always` negatively impacts your app's cold start behavior and data throughput. The default `debugOnly` setting generates log files when you are debugging using the Azure portal. |
394+
|fileLoggingMode|debugOnly|Determines the file logging behavior when running in Azure. Options are `never`, `always`, and `debugOnly`. This setting isn't used when running locally. When possible, you should use Application Insights when debugging your functions in Azure. Using `always` negatively impacts your app's cold start behavior and data throughput. The default `debugOnly` setting generates log files when you're debugging using the Azure portal. |
395395
|logLevel|n/a|Object that defines the log category filtering for functions in the app. This setting lets you filter logging for specific functions. For more information, see [Configure log levels](configure-monitoring.md#configure-log-levels). |
396396
|console|n/a| The [console](#console) logging setting. |
397397
|applicationInsights|n/a| The [applicationInsights](#applicationinsights) setting. |
@@ -460,7 +460,7 @@ A set of [shared code directories](functions-reference-csharp.md#watched-directo
460460

461461
## watchFiles
462462

463-
An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions.
463+
An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files is changed, the updates are picked up by your functions.
464464

465465
```json
466466
{

articles/azure-functions/functions-versions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.custom:
77
- devx-track-js
88
- devx-track-python
99
- ignite-2023
10-
ms.date: 09/01/2023
10+
ms.date: 02/26/2024
1111
zone_pivot_groups: programming-languages-set-functions
1212
---
1313

@@ -82,7 +82,7 @@ For C# script, update the extension bundle reference in the host.json as follows
8282
"version": "2.0",
8383
"extensionBundle": {
8484
"id": "Microsoft.Azure.Functions.ExtensionBundle",
85-
"version": "[2.*, 3.0.0)"
85+
"version": "[4.0.0, 5.0.0)"
8686
}
8787
}
8888
```
@@ -98,7 +98,7 @@ If you receive a warning about your extension bundle version not meeting a minim
9898
"version": "2.0",
9999
"extensionBundle": {
100100
"id": "Microsoft.Azure.Functions.ExtensionBundle",
101-
"version": "[2.*, 3.0.0)"
101+
"version": "[4.0.0, 5.0.0)"
102102
}
103103
}
104104
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
author: lilyjma
3+
ms.service: azure-functions
4+
ms.topic: include
5+
ms.date: 02/24/2024
6+
ms.author: jiayma
7+
---
8+
9+
```json
10+
{
11+
"version": "2.0",
12+
"extensionBundle": {
13+
"id": "Microsoft.Azure.Functions.ExtensionBundle",
14+
"version": "[4.0.0, 5.0.0)"
15+
}
16+
}
17+
```

includes/functions-extension-bundles-json.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
author: ggailey777
33
ms.service: azure-functions
44
ms.topic: include
5-
ms.date: 07/11/2023
5+
ms.date: 02/26/2024
66
ms.author: glenga
77
---
88

9-
[!INCLUDE [functions-extension-bundles-json-v3](./functions-extension-bundles-json-v3.md)]
9+
[!INCLUDE [functions-extension-bundles-json-v4](./functions-extension-bundles-json-v4.md)]
1010

1111
The following properties are available in `extensionBundle`:
1212

1313
| Property | Description |
1414
| -------- | ----------- |
1515
| **`id`** | The namespace for Microsoft Azure Functions extension bundles. |
16-
| **`version`** | The version range of the bundle to install. The Functions runtime always picks the maximum permissible version defined by the version range or interval. For example, a `version` value range of `[3.3.0, 4.0.0)` allows all bundle versions from 3.3.0 up to but not including 4.0.0. For more information, see the [interval notation for specifying version ranges](/nuget/reference/package-versioning#version-ranges). |
16+
| **`version`** | The version range of the bundle to install. The Functions runtime always picks the maximum permissible version defined by the version range or interval. For example, a `version` value range of `[4.0.0, 5.0.0)` allows all bundle versions from 4.0.0 up to but not including 5.0.0. For more information, see the [interval notation for specifying version ranges](/nuget/reference/package-versioning#version-ranges). |

0 commit comments

Comments
 (0)