Skip to content

Commit a361e86

Browse files
authored
Merge pull request #50043 from ggailey777/cleanup
Clarify note about SQL APIs only.
2 parents c518ae2 + 11ce2bd commit a361e86

File tree

4 files changed

+29
-16
lines changed

4 files changed

+29
-16
lines changed

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ This article explains how to work with [Azure Cosmos DB](..\cosmos-db\serverless
3333
3434
[!INCLUDE [intro](../../includes/functions-bindings-intro.md)]
3535

36+
## Supported APIs
37+
38+
[!INCLUDE [SQL API support only](../../includes/functions-cosmosdb-sqlapi-note.md)]
39+
3640
## Packages - Functions 2.x
3741

3842
The Azure Cosmos DB bindings for Functions version 2.x are provided in the [Microsoft.Azure.WebJobs.Extensions.CosmosDB](http://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.CosmosDB) NuGet package, version 3.x. Source code for the bindings is in the [azure-webjobs-sdk-extensions](https://github.com/Azure/azure-webjobs-sdk-extensions/blob/master/src/WebJobs.Extensions.CosmosDB/) GitHub repository.
@@ -250,10 +254,7 @@ The trigger doesn't indicate whether a document was updated or inserted, it just
250254

251255
## Input
252256

253-
The Azure Cosmos DB input binding retrieves one or more Azure Cosmos DB documents and passes them to the input parameter of the function. The document ID or query parameters can be determined based on the trigger that invokes the function.
254-
255-
>[!NOTE]
256-
> Don't use Azure Cosmos DB input or output bindings if you're using MongoDB API on a Cosmos DB account. Data corruption is possible.
257+
The Azure Cosmos DB input binding uses the SQL API to retrieve one or more Azure Cosmos DB documents and passes them to the input parameter of the function. The document ID or query parameters can be determined based on the trigger that invokes the function.
257258

258259
## Input - examples
259260

@@ -1250,10 +1251,7 @@ In JavaScript functions, updates are not made automatically upon function exit.
12501251

12511252
## Output
12521253

1253-
The Azure Cosmos DB output binding lets you write a new document to an Azure Cosmos DB database.
1254-
1255-
>[!NOTE]
1256-
> Don't use Azure Cosmos DB input or output bindings if you're using MongoDB API on a Cosmos DB account. Data corruption is possible.
1254+
The Azure Cosmos DB output binding lets you write a new document to an Azure Cosmos DB database using the SQL API.
12571255

12581256
## Output - examples
12591257

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ This article explains how to work with [Azure Cosmos DB](..\cosmos-db\serverless
3333
3434
[!INCLUDE [intro](../../includes/functions-bindings-intro.md)]
3535

36+
## Supported APIs
37+
38+
[!INCLUDE [SQL API support only](../../includes/functions-cosmosdb-sqlapi-note.md)]
39+
3640
## Packages - Functions 1.x
3741

3842
The Azure Cosmos DB bindings for Functions version 1.x are provided in the [Microsoft.Azure.WebJobs.Extensions.DocumentDB](http://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DocumentDB) NuGet package, version 1.x. Source code for the bindings is in the [azure-webjobs-sdk-extensions](https://github.com/Azure/azure-webjobs-sdk-extensions/tree/v2.x/src/WebJobs.Extensions.DocumentDB) GitHub repository.
@@ -212,10 +216,7 @@ The trigger doesn't indicate whether a document was updated or inserted, it just
212216

213217
## Input
214218

215-
The Azure Cosmos DB input binding retrieves one or more Azure Cosmos DB documents and passes them to the input parameter of the function. The document ID or query parameters can be determined based on the trigger that invokes the function.
216-
217-
>[!NOTE]
218-
> Don't use Azure Cosmos DB input or output bindings if you're using MongoDB API on a Cosmos DB account. Data corruption is possible.
219+
The Azure Cosmos DB input binding uses the SQL API to retrieve one or more Azure Cosmos DB documents and passes them to the input parameter of the function. The document ID or query parameters can be determined based on the trigger that invokes the function.
219220

220221
## Input - examples
221222

@@ -1182,10 +1183,7 @@ In JavaScript functions, updates are not made automatically upon function exit.
11821183

11831184
## Output
11841185

1185-
The Azure Cosmos DB output binding lets you write a new document to an Azure Cosmos DB database.
1186-
1187-
>[!NOTE]
1188-
> Don't use Azure Cosmos DB input or output bindings if you're using MongoDB API on a Cosmos DB account. Data corruption is possible.
1186+
The Azure Cosmos DB output binding lets you write a new document to an Azure Cosmos DB database using the SQL API.
11891187

11901188
## Output - examples
11911189

articles/azure-functions/functions-create-cosmos-db-triggered-function.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ To complete this tutorial:
3030

3131
+ If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
3232

33+
> [!NOTE]
34+
> [!INCLUDE [SQL API support only](../../includes/functions-cosmosdb-sqlapi-note.md)]
35+
3336
## Create an Azure Function app
3437

3538
[!INCLUDE [Create function app Azure portal](../../includes/functions-create-function-app-portal.md)]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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/22/2018
10+
ms.author: glenga
11+
ms.custom: include file
12+
---
13+
14+
Azure Cosmos DB bindings are only supported for use with the SQL API. For all other Azure Cosmos DB APIs, you should access the database from your function by using the static client for your API, including [MongoDB API](../articles/cosmos-db/mongodb-introduction.md), [Cassandra API](../articles/cosmos-db/cassandra-introduction.md), [Gremlin API](../articles/cosmos-db/graph-introduction.md), and [Table API](../articles/cosmos-db/table-introduction.md).

0 commit comments

Comments
 (0)