Skip to content

Commit 6cd50e9

Browse files
committed
Add preview bundles info
1 parent 1efe5c6 commit 6cd50e9

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

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

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@ Extension bundles add a predefined set of compatible binding extensions to your
2222

2323
When you create an Azure Functions project from a non-.NET template, extension bundles are already enabled in the app's *host.json* file.
2424

25+
### Define an extension bundle
26+
2527
You define an extension bundle reference in the *host.json* project file by adding an `extensionBundle` section, as in this example:
2628

2729
[!INCLUDE [functions-extension-bundles-json](../../includes/functions-extension-bundles-json.md)]
2830

29-
The following table lists the currently available default *Microsoft.Azure.Functions.ExtensionBundle* bundles, defined using version ranges and with links to the extension definitions for the bundle.
31+
### Supported extension bundles
32+
33+
The following table lists the default `Microsoft.Azure.Functions.ExtensionBundle` bundles that are currently generally available (GA).
3034

3135
| Bundle version | Version in host.json | Included extensions |
3236
| --- | --- | --- |
@@ -35,12 +39,34 @@ The following table lists the currently available default *Microsoft.Azure.Funct
3539
| 2.x | `[2.*, 3.0.0)` | See [extensions.json](https://github.com/Azure/azure-functions-extension-bundles/blob/main-v2/src/Microsoft.Azure.Functions.ExtensionBundle/extensions.json) used to generate the bundle. |
3640
| 1.x | `[1.*, 2.0.0)` | See [extensions.json](https://github.com/Azure/azure-functions-extension-bundles/blob/v1.x/src/Microsoft.Azure.Functions.ExtensionBundle/extensions.json) used to generate the bundle. |
3741

42+
The default extension bundles are defined using version ranges, and this table links to the extension definitions for the bundle. For a complete list of extension bundle releases and extension versions in each release, see the [extension bundles release page](https://github.com/Azure/azure-functions-extension-bundles/releases).
43+
44+
### Extension bundles considerations
45+
3846
Keep these considerations in mind when working with extension bundles:
3947

4048
+ When possible, you should set a `version` range value in *host.json* from this table, such as `[4.0.0, 5.0.0)`, instead of defining a custom range.
4149
+ Use the latest version range to obtain optimal app performance and access to the latest features.
4250

43-
For a complete list of extension bundle releases and extension versions in each release, see the [extension bundles release page](https://github.com/Azure/azure-functions-extension-bundles/releases).
51+
### Preview extension bundles
52+
53+
Prerelease versions of specific binding extensions are frequently made available in preview extension bundles. These preview extension bundles, which have an ID of `Microsoft.Azure.Functions.ExtensionBundle.Preview`, allow you to take advantage of new extension behaviors before they are declared as GA. Keep these considerations in mind when choosing to use a non-GA extension bundle:
54+
55+
+ Preview bundles can include features that are still under development and not yet ready for production use.
56+
+ Breaking changes occur between preview versions without prior notice, which can include changes to:
57+
+ Trigger and binding definitions
58+
+ Extensions included in the preview
59+
+ Performance characteristics and stability
60+
+ Security updates might require you to upgrade versions.
61+
+ You must completely test preview bundles in nonproduction environments and avoid using preview bundles in production. When you must use a preview bundle in production, take these extra precautions:
62+
+ Pin your bundle to a specific well-tested bundle version instead of to a range. Pinning prevents automatic upgrading of your bundle version before you have a chance to verify the update in a nonproduction environment.
63+
+ Move your app to using a GA bundle version as soon as the functionality becomes available in a fully supported bundle release.
64+
+ To stay informed about bundle updates, including moving from preview to GA, you should:
65+
+ Monitor preview bundle version releases on the [extension bundles release page](https://github.com/Azure/azure-functions-extension-bundles/releases). - Releases · Azure/azure-functions-extension-bundles
66+
+ Monitor [extension specific reference documentation](./functions-triggers-bindings.md).
67+
+ Review the NuGet package versions of specific preview extensions you're using.
68+
+ Track significant updates or changes on the change logs published on NuGet.org for each preview extension.
69+
4470
::: zone-end
4571

4672
## Explicitly install extensions

0 commit comments

Comments
 (0)