Skip to content

Commit 3baf549

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #219940 from jcocchi/cosmos-db-functions-extension-ga
Update Azure Cosmos DB Azure Functions extension v4 for ga
2 parents 7e71b57 + 25fbfc5 commit 3baf549

7 files changed

+39
-42
lines changed

‎articles/azure-functions/functions-bindings-cosmosdb-v2-input.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ namespace CosmosDBSamplesV2
425425

426426
This section contains examples that require version 3.x of Azure Cosmos DB extension and 5.x of Azure Storage extension. If not already present in your function app, add reference to the following NuGet packages:
427427

428-
* [Microsoft.Azure.Functions.Worker.Extensions.CosmosDB](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB/3.0.9)
428+
* [Microsoft.Azure.Functions.Worker.Extensions.CosmosDB](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB)
429429
* [Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues/5.0.0)
430430

431431
* [Queue trigger, look up ID from JSON](#queue-trigger-look-up-id-from-json-isolated)
@@ -1695,23 +1695,23 @@ Both [in-process](functions-dotnet-class-library.md) and [isolated worker proces
16951695

16961696
[!INCLUDE [functions-cosmosdb-input-attributes-v3](../../includes/functions-cosmosdb-input-attributes-v3.md)]
16971697

1698-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
1698+
# [Extension 4.x+](#tab/extensionv4/in-process)
16991699

17001700
[!INCLUDE [functions-cosmosdb-input-attributes-v4](../../includes/functions-cosmosdb-input-attributes-v4.md)]
17011701

17021702
# [Functions 2.x+](#tab/functionsv2/isolated-process)
17031703

17041704
[!INCLUDE [functions-cosmosdb-input-attributes-v3](../../includes/functions-cosmosdb-input-attributes-v3.md)]
17051705

1706-
# [Extension 4.x+ (preview)](#tab/extensionv4/isolated-process)
1706+
# [Extension 4.x+](#tab/extensionv4/isolated-process)
17071707

17081708
[!INCLUDE [functions-cosmosdb-input-attributes-v4](../../includes/functions-cosmosdb-input-attributes-v4.md)]
17091709

17101710
# [Functions 2.x+](#tab/functionsv2/csharp-script)
17111711

17121712
[!INCLUDE [functions-cosmosdb-input-settings-v3](../../includes/functions-cosmosdb-input-settings-v3.md)]
17131713

1714-
# [Extension 4.x+ (preview)](#tab/extensionv4/csharp-script)
1714+
# [Extension 4.x+](#tab/extensionv4/csharp-script)
17151715

17161716
[!INCLUDE [functions-cosmosdb-input-settings-v4](../../includes/functions-cosmosdb-input-settings-v4.md)]
17171717

@@ -1742,7 +1742,7 @@ The following table explains the binding configuration properties that you set i
17421742

17431743
[!INCLUDE [functions-cosmosdb-settings-v3](../../includes/functions-cosmosdb-input-settings-v3.md)]
17441744

1745-
# [Extension 4.x+ (preview)](#tab/extensionv4)
1745+
# [Extension 4.x+](#tab/extensionv4)
17461746

17471747
[!INCLUDE [functions-cosmosdb-settings-v4](../../includes/functions-cosmosdb-input-settings-v4.md)]
17481748

@@ -1761,23 +1761,23 @@ The parameter type supported by the Event Grid trigger depends on the Functions
17611761

17621762
[!INCLUDE [functions-cosmosdb-usage](../../includes/functions-cosmosdb-usage.md)]
17631763

1764-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
1764+
# [Extension 4.x+](#tab/extensionv4/in-process)
17651765

17661766
[!INCLUDE [functions-cosmosdb-usage](../../includes/functions-cosmosdb-usage.md)]
17671767

17681768
# [Functions 2.x+](#tab/functionsv2/isolated-process)
17691769

17701770
[!INCLUDE [functions-cosmosdb-usage](../../includes/functions-cosmosdb-usage.md)]
17711771

1772-
# [Extension 4.x+ (preview)](#tab/extensionv4/isolated-process)
1772+
# [Extension 4.x+](#tab/extensionv4/isolated-process)
17731773

17741774
Only JSON string inputs are currently supported.
17751775

17761776
# [Functions 2.x+](#tab/functionsv2/csharp-script)
17771777

17781778
[!INCLUDE [functions-cosmosdb-settings-v3](../../includes/functions-cosmosdb-input-settings-v3.md)]
17791779

1780-
# [Extension 4.x+ (preview)](#tab/extensionv4/csharp-script)
1780+
# [Extension 4.x+](#tab/extensionv4/csharp-script)
17811781

17821782
[!INCLUDE [functions-cosmosdb-settings-v4](../../includes/functions-cosmosdb-input-settings-v4.md)]
17831783

‎articles/azure-functions/functions-bindings-cosmosdb-v2-output.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -632,23 +632,23 @@ Both [in-process](functions-dotnet-class-library.md) and [isolated worker proces
632632

633633
[!INCLUDE [functions-cosmosdb-output-attributes-v3](../../includes/functions-cosmosdb-output-attributes-v3.md)]
634634

635-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
635+
# [Extension 4.x+](#tab/extensionv4/in-process)
636636

637637
[!INCLUDE [functions-cosmosdb-output-attributes-v4](../../includes/functions-cosmosdb-output-attributes-v4.md)]
638638

639639
# [Functions 2.x+](#tab/functionsv2/isolated-process)
640640

641641
[!INCLUDE [functions-cosmosdb-output-attributes-v3](../../includes/functions-cosmosdb-output-attributes-v3.md)]
642642

643-
# [Extension 4.x+ (preview)](#tab/functionsv4/isolated-process)
643+
# [Extension 4.x+](#tab/functionsv4/isolated-process)
644644

645645
[!INCLUDE [functions-cosmosdb-output-attributes-v4](../../includes/functions-cosmosdb-output-attributes-v4.md)]
646646

647647
# [Functions 2.x+](#tab/functionsv2/csharp-script)
648648

649649
[!INCLUDE [functions-cosmosdb-output-settings-v3](../../includes/functions-cosmosdb-output-settings-v3.md)]
650650

651-
# [Extension 4.x+ (preview)](#tab/functionsv4/csharp-script)
651+
# [Extension 4.x+](#tab/functionsv4/csharp-script)
652652

653653
[!INCLUDE [functions-cosmosdb-output-settings-v4](../../includes/functions-cosmosdb-output-settings-v4.md)]
654654

@@ -679,7 +679,7 @@ The following table explains the binding configuration properties that you set i
679679

680680
[!INCLUDE [functions-cosmosdb-settings-v3](../../includes/functions-cosmosdb-output-settings-v3.md)]
681681

682-
# [Extension 4.x+ (preview)](#tab/extensionv4)
682+
# [Extension 4.x+](#tab/extensionv4)
683683

684684
[!INCLUDE [functions-cosmosdb-settings-v4](../../includes/functions-cosmosdb-output-settings-v4.md)]
685685

‎articles/azure-functions/functions-bindings-cosmosdb-v2-trigger.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: Azure Cosmos DB trigger for Functions 2.x and higher
33
description: Learn to use the Azure Cosmos DB trigger in Azure Functions.
44
ms.topic: reference
5-
ms.date: 03/04/2022
5+
ms.date: 11/29/2022
66
ms.devlang: csharp, java, javascript, powershell, python
77
ms.custom: devx-track-csharp, devx-track-python, ignite-2022
88
zone_pivot_groups: programming-languages-set-functions-lang-workers
99
---
1010

1111
# Azure Cosmos DB trigger for Azure Functions 2.x and higher
1212

13-
The Azure Cosmos DB Trigger uses the [Azure Cosmos DB Change Feed](../cosmos-db/change-feed.md) to listen for inserts and updates across partitions. The change feed publishes inserts and updates, not deletions.
13+
The Azure Cosmos DB Trigger uses the [Azure Cosmos DB change feed](../cosmos-db/change-feed.md) to listen for inserts and updates across partitions. The change feed publishes new and updated items, not including updates from deletions.
1414

1515
For information on setup and configuration details, see the [overview](./functions-bindings-cosmosdb-v2.md).
1616

@@ -70,7 +70,7 @@ namespace CosmosDBSamplesV2
7070
}
7171
```
7272

73-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
73+
# [Extension 4.x+](#tab/extensionv4/in-process)
7474

7575
Apps using [Azure Cosmos DB extension version 4.x](./functions-bindings-cosmosdb-v2.md?tabs=extensionv4) or higher will have different attribute properties, which are shown below. This example refers to a simple `ToDoItem` type.
7676

@@ -124,7 +124,7 @@ This document type is the type of the [`IReadOnlyList<T>`](/dotnet/api/system.co
124124
:::code language="csharp" source="~/azure-functions-dotnet-worker/samples/Extensions/CosmosDB/CosmosDBFunction.cs" range="4-35":::
125125

126126

127-
# [Extension 4.x+ (preview)](#tab/extensionv4/isolated-process)
127+
# [Extension 4.x+](#tab/extensionv4/isolated-process)
128128

129129
Example pending.
130130

@@ -164,7 +164,7 @@ Here's the C# script code:
164164
}
165165
```
166166

167-
# [Extension 4.x+ (preview)](#tab/extensionv4/csharp-script)
167+
# [Extension 4.x+](#tab/extensionv4/csharp-script)
168168

169169
The following example shows an Azure Cosmos DB trigger binding in a *function.json* file and a [C# script function](functions-reference-csharp.md) that uses the binding. The function writes log messages when Azure Cosmos DB records are added or modified.
170170

@@ -222,7 +222,7 @@ This function is invoked when there are inserts or updates in the specified data
222222
context.getLogger().info(items.length + "item(s) is/are changed.");
223223
}
224224
```
225-
# [Extension 4.x+ (preview)](#tab/extensionv4)
225+
# [Extension 4.x+](#tab/extensionv4)
226226

227227
[!INCLUDE [functions-cosmosdb-extension-java-note](../../includes/functions-cosmosdb-extension-java-note.md)]
228228

@@ -293,23 +293,23 @@ Both [in-process](functions-dotnet-class-library.md) and [isolated process](dotn
293293

294294
[!INCLUDE [functions-cosmosdb-attributes-v3](../../includes/functions-cosmosdb-attributes-v3.md)]
295295

296-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
296+
# [Extension 4.x+](#tab/extensionv4/in-process)
297297

298298
[!INCLUDE [functions-cosmosdb-attributes-v4](../../includes/functions-cosmosdb-attributes-v4.md)]
299299

300300
# [Functions 2.x+](#tab/functionsv2/isolated-process)
301301

302302
[!INCLUDE [functions-cosmosdb-attributes-v3](../../includes/functions-cosmosdb-attributes-v3.md)]
303303

304-
# [Extension 4.x+ (preview)](#tab/extensionv4/isolated-process)
304+
# [Extension 4.x+](#tab/extensionv4/isolated-process)
305305

306306
[!INCLUDE [functions-cosmosdb-attributes-v4](../../includes/functions-cosmosdb-attributes-v4.md)]
307307

308308
# [Functions 2.x+](#tab/functionsv2/csharp-script)
309309

310310
[!INCLUDE [functions-cosmosdb-settings-v3](../../includes/functions-cosmosdb-settings-v3.md)]
311311

312-
# [Extension 4.x+ (preview)](#tab/extensionv4/csharp-script)
312+
# [Extension 4.x+](#tab/extensionv4/csharp-script)
313313

314314
[!INCLUDE [functions-cosmosdb-settings-v4](../../includes/functions-cosmosdb-settings-v4.md)]
315315

@@ -343,7 +343,7 @@ From the [Java functions runtime library](/java/api/overview/azure/functions/run
343343
+ [startFromBeginning](/java/api/com.microsoft.azure.functions.annotation.cosmosdbtrigger.startfrombeginning)
344344
+ [preferredLocations](/java/api/com.microsoft.azure.functions.annotation.cosmosdbtrigger.preferredlocations)
345345

346-
# [Extension 4.x+ (preview)](#tab/extensionv4)
346+
# [Extension 4.x+](#tab/extensionv4)
347347

348348
[!INCLUDE [functions-cosmosdb-extension-java-note](../../includes/functions-cosmosdb-extension-java-note.md)]
349349

@@ -359,7 +359,7 @@ The following table explains the binding configuration properties that you set i
359359

360360
[!INCLUDE [functions-cosmosdb-settings-v3](../../includes/functions-cosmosdb-settings-v3.md)]
361361

362-
# [Extension 4.x+ (preview)](#tab/extensionv4)
362+
# [Extension 4.x+](#tab/extensionv4)
363363

364364
[!INCLUDE [functions-cosmosdb-settings-v4](../../includes/functions-cosmosdb-settings-v4.md)]
365365

‎articles/azure-functions/functions-bindings-cosmosdb-v2.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Azure Cosmos DB bindings for Functions 2.x and higher
33
description: Understand how to use Azure Cosmos DB triggers and bindings in Azure Functions.
44
ms.topic: reference
55
ms.custom: ignite-2022
6-
ms.date: 03/04/2022
6+
ms.date: 11/29/2022
77
zone_pivot_groups: programming-languages-set-functions-lang-workers
88
---
99

@@ -55,40 +55,37 @@ The process for installing the extension varies depending on the extension versi
5555

5656
Working with the trigger and bindings requires that you reference the appropriate NuGet package. Install the [NuGet package](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.CosmosDB/3.0.10), version 3.x.
5757

58-
# [Extension 4.x+ (preview)](#tab/extensionv4/in-process)
58+
# [Extension 4.x+](#tab/extensionv4/in-process)
5959

60-
This preview version of the Azure Cosmos DB bindings extension introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
60+
This version of the Azure Cosmos DB bindings extension introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
6161

6262
This version also changes the types that you can bind to, replacing the types from the v2 SDK `Microsoft.Azure.DocumentDB` with newer types from the v3 SDK [Microsoft.Azure.Cosmos](../cosmos-db/sql/sql-api-sdk-dotnet-standard.md). Learn more about how these new types are different and how to migrate to them from the [SDK migration guide](../cosmos-db/sql/migrate-dotnet-v3.md), [trigger](./functions-bindings-cosmosdb-v2-trigger.md), [input binding](./functions-bindings-cosmosdb-v2-input.md), and [output binding](./functions-bindings-cosmosdb-v2-output.md) examples.
6363

64-
This extension version is available as a [preview NuGet package](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.CosmosDB/4.0.0-preview3).
65-
66-
> [!NOTE]
67-
> Authentication with an identity instead of a secret using the 4.x preview extension is currently only available for Elastic Premium plans.
64+
This extension version is available as a [NuGet package](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.CosmosDB), version 4.x.
6865

6966
# [Functions 2.x+](#tab/functionsv2/isolated-process)
7067

7168
Add the extension to your project by installing the [NuGet package](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB/), version 3.x.
7269

73-
# [Extension 4.x+ (preview)](#tab/extensionv4/isolated-process)
70+
# [Extension 4.x+](#tab/extensionv4/isolated-process)
7471

75-
This preview version of the Azure Cosmos DB bindings extension introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
72+
This version of the Azure Cosmos DB bindings extension introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
7673

7774
Add the extension to your project by installing the [NuGet package](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB/), version 4.x.
7875

7976
# [Functions 2.x+](#tab/functionsv2/csharp-script)
8077

8178
You can install this version of the extension in your function app by registering the [extension bundle], version 2.x.
8279

83-
# [Extension 4.x+ (preview)](#tab/extensionv4/csharp-script)
80+
# [Extension 4.x+](#tab/extensionv4/csharp-script)
8481

85-
This extension version is available from the preview extension bundle v4 by adding the following lines in your `host.json` file:
82+
This extension version is available from the extension bundle v4 by adding the following lines in your `host.json` file:
8683

8784
```json
8885
{
8986
"version": "2.0",
9087
"extensionBundle": {
91-
"id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
88+
"id": "Microsoft.Azure.Functions.ExtensionBundle",
9289
"version": "[4.0.0, 5.0.0)"
9390
}
9491
}
@@ -110,9 +107,9 @@ You can install this version of the extension in your function app by registerin
110107

111108
[!INCLUDE [functions-extension-bundles-json-v3](../../includes/functions-extension-bundles-json-v3.md)]
112109

113-
# [Bundle v4.x (Preview)](#tab/extensionv4)
110+
# [Bundle v4.x](#tab/extensionv4)
114111

115-
This version of the bundle contains a preview version of the Azure Cosmos DB bindings extension (version 4.x) that introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
112+
This version of the bundle contains version 4.x of the Azure Cosmos DB bindings extension that introduces the ability to [connect using an identity instead of a secret](./functions-reference.md#configure-an-identity-based-connection). For a tutorial on configuring your function apps with managed identities, see the [creating a function app with identity-based connections tutorial](./functions-identity-based-connections-tutorial.md).
116113

117114
::: zone-end
118115
::: zone pivot="programming-language-java"
@@ -173,7 +170,7 @@ To learn more, see [Update your extensions].
173170
|**protocol**|`Https`|The connection protocol used by the function when connection to the Azure Cosmos DB service. Read [here for an explanation of both modes](../cosmos-db/performance-tips.md#networking). |
174171
|**leasePrefix**|n/a|Lease prefix to use across all functions in an app. |
175172

176-
# [Extension 4.x+ (preview)](#tab/extensionv4)
173+
# [Extension 4.x+](#tab/extensionv4)
177174

178175
```json
179176
{

‎articles/azure-functions/functions-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Identity-based connections are supported by the following components:
121121
| Azure Tables (when using Azure Storage) | All | [Azure Tables extension version 1.0.0 or later](./functions-bindings-storage-table.md#table-api-extension),<br/>[Extension bundle 3.3.0 or later][tablesv1] |
122122
| Azure Event Hubs triggers and bindings | All | [Azure Event Hubs extension version 5.0.0 or later][eventhubv5],<br/>[Extension bundle 3.3.0 or later][eventhubv5] |
123123
| Azure Service Bus triggers and bindings | All | [Azure Service Bus extension version 5.0.0 or later][servicebusv5],<br/>[Extension bundle 3.3.0 or later][servicebusv5] |
124-
| Azure Cosmos DB triggers and bindings - Preview | Elastic Premium | [Azure Cosmos DB extension version 4.0.0-preview1 or later][cosmosv4],<br/> [Preview extension bundle 4.0.0 or later][cosmosv4]|
124+
| Azure Cosmos DB triggers and bindings | All | [Azure Cosmos DB extension version 4.0.0 or later][cosmosv4],<br/> [Extension bundle 4.0.2 or later][cosmosv4]|
125125
| Durable Functions storage provider (Azure Storage) - Preview | All | [Durable Functions extension version 2.7.0 or later][durable-identity],<br/>[Extension bundle 3.3.0 or later][durable-identity] |
126126
| Host-required storage ("AzureWebJobsStorage") - Preview | All | [Connecting to host storage with an identity](#connecting-to-host-storage-with-an-identity-preview) |
127127

@@ -157,7 +157,7 @@ Choose a tab below to learn about permissions for each component:
157157

158158
[!INCLUDE [functions-service-bus-permissions](../../includes/functions-service-bus-permissions.md)]
159159

160-
# [Azure Cosmos DB extension (preview)](#tab/cosmos)
160+
# [Azure Cosmos DB extension](#tab/cosmos)
161161

162162
[!INCLUDE [functions-cosmos-permissions](../../includes/functions-cosmos-permissions.md)]
163163

‎includes/functions-cosmosdb-attributes-v4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.author: glenga
1010
|**Connection** | The name of an app setting or setting collection that specifies how to connect to the Azure Cosmos DB account being monitored. For more information, see [Connections](#connections).|
1111
|**DatabaseName** | The name of the Azure Cosmos DB database with the container being monitored. |
1212
|**ContainerName** | The name of the container being monitored. |
13-
|**LeaseConnectionStringSetting** | (Optional) The name of an app setting or setting container that specifies how to connect to the Azure Cosmos DB account that holds the lease container. <br><br> When not set, the `ConnectionStringSetting` value is used. This parameter is automatically set when the binding is created in the portal. The connection string for the leases container must have write permissions.|
13+
|**LeaseConnection** | (Optional) The name of an app setting or setting container that specifies how to connect to the Azure Cosmos DB account that holds the lease container. <br><br> When not set, the `Connection` value is used. This parameter is automatically set when the binding is created in the portal. The connection string for the leases container must have write permissions.|
1414
|**LeaseDatabaseName** | (Optional) The name of the database that holds the container used to store leases. When not set, the value of the `databaseName` setting is used. |
1515
|**LeaseContainerName** | (Optional) The name of the container used to store leases. When not set, the value `leases` is used. |
1616
|**CreateLeaseContainerIfNotExists** | (Optional) When set to `true`, the leases container is automatically created when it doesn't already exist. The default value is `false`. When using Azure AD identities if you set the value to `true`, creating containers is not [an allowed operation](../articles/cosmos-db/sql/troubleshoot-forbidden.md#non-data-operations-are-not-allowed) and your Function won't be able to start.|

0 commit comments

Comments
 (0)