Skip to content

Commit 64521f1

Browse files
committed
update how to with sdk versions and images
1 parent bb28379 commit 64521f1

8 files changed

+20
-20
lines changed

articles/cosmos-db/dedicated-gateway.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: seesharprun
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-sql
77
ms.topic: conceptual
8-
ms.date: 08/02/2022
8+
ms.date: 08/29/2022
99
ms.author: sidandrews
1010
ms.reviewer: jucocchi
1111
---
@@ -17,7 +17,7 @@ A dedicated gateway is server-side compute that is a front-end to your Azure Cos
1717

1818
## Overview
1919

20-
You can provision a dedicated gateway to improve performance at scale. The most common reason that you would want to provision a dedicated gateway would be for caching. When you provision a dedicated gateway, an [integrated cache](integrated-cache.md) is automatically configured within the dedicated gateway. Point reads and queries that hit the integrated cache do not use any of your RUs. Provisioning a dedicated gateway with an integrated cache can help read-heavy workloads lower costs on Azure Cosmos DB.
20+
You can provision a dedicated gateway to improve performance at scale. The most common reason that you would want to provision a dedicated gateway is for caching. When you provision a dedicated gateway, an [integrated cache](integrated-cache.md) is automatically configured within the dedicated gateway. Point reads and queries that hit the integrated cache do not use any of your RUs. Provisioning a dedicated gateway with an integrated cache can help read-heavy workloads lower costs on Azure Cosmos DB.
2121

2222
The dedicated gateway is built into Azure Cosmos DB. When you [provision a dedicated gateway](how-to-configure-integrated-cache.md), you have a fully-managed node that routes requests to backend partitions. Connecting to Azure Cosmos DB with the dedicated gateway provides lower and more predictable latency than connecting to Azure Cosmos DB with the standard gateway. Even cache misses will see latency improvements when comparing the dedicated gateway and standard gateway.
2323

@@ -31,7 +31,7 @@ [email protected]
3131

3232
There are two [connectivity modes](./sql/sql-sdk-connection-modes.md) for Azure Cosmos DB, Direct mode and Gateway mode. With Gateway mode you can connect to either the standard gateway or the dedicated gateway depending on the endpoint you configure.
3333

34-
:::image type="content" source="./media/dedicated-gateway/connection-policy.png" alt-text="An image that shows how Cosmos DB connectivity modes work." border="false":::
34+
:::image type="content" source="./media/dedicated-gateway/connection-policy.png" alt-text="An image that shows how Cosmos DB connectivity modes work." :::
3535

3636
### Connect to Azure Cosmos DB using direct mode
3737

@@ -43,18 +43,18 @@ If you connect to Azure Cosmos DB using gateway mode, your application will conn
4343

4444
When connecting to Azure Cosmos DB with gateway mode, you can connect with either of the following options:
4545

46-
* **Standard gateway** - While the backend, which includes your provisioned throughput and storage, has dedicated capacity per container, the standard gateway is shared between many Azure Cosmos accounts. It is practical for many customers to share a standard gateway since the compute resources consumed by each individual customer is small.
46+
* **Standard gateway** - While the backend, which includes your provisioned throughput and storage, has dedicated capacity per container, the standard gateway is shared between many Azure Cosmos DB accounts. It is practical for many customers to share a standard gateway since the compute resources consumed by each individual customer is small.
4747
* **Dedicated gateway** - In this gateway, the backend and gateway both have dedicated capacity. The integrated cache requires a dedicated gateway because it requires significant CPU and memory that is specific to your Azure Cosmos account.
4848

4949
You must connect to Azure Cosmos DB using the dedicated gateway in order to use the integrated cache. The dedicated gateway has a different endpoint from the standard one provided with your Azure Cosmos DB account, but requests are routed in the same way. When you connect to your dedicated gateway endpoint, your application sends a request to the dedicated gateway, which then routes the request to different backend nodes. If possible, the integrated cache will serve the result.
5050

5151
Diagram of gateway mode connection with a dedicated gateway:
5252

53-
:::image type="content" source="./media/dedicated-gateway/dedicated-gateway-connection-policy.png" alt-text="An image that shows how the Cosmos DB dedicated gateway works." border="false":::
53+
:::image type="content" source="./media/dedicated-gateway/dedicated-gateway-connection-policy.png" alt-text="An image that shows how the Cosmos DB dedicated gateway works." :::
5454

5555
## Provisioning the dedicated gateway
5656

57-
A dedicated gateway cluster can be provisioned in Core (SQL) API accounts. A dedicated gateway cluster can have up to five nodes and you can add or remove nodes at any time. All dedicated gateway nodes within your account [share the same connection string](how-to-configure-integrated-cache.md#configuring-the-integrated-cache).
57+
A dedicated gateway cluster can be provisioned in Core (SQL) API accounts. A dedicated gateway cluster can have up to five nodes by default and you can add or remove nodes at any time. All dedicated gateway nodes within your account [share the same connection string](how-to-configure-integrated-cache.md#configuring-the-integrated-cache).
5858

5959
Dedicated gateway nodes are independent from one another. When you provision multiple dedicated gateway nodes, any single node can route any given request. In addition, each node has a separate integrated cache from the others. The cached data within each node depends on the data that was recently [written or read](integrated-cache.md#item-cache) through that specific node. If an item or query is cached on one node, it isn't necessarily cached on the others.
6060

@@ -74,7 +74,7 @@ The dedicated gateway is available in the following sizes. The integrated cache
7474
There are many different ways to provision a dedicated gateway:
7575

7676
- [Provision a dedicated gateway using the Azure Portal](how-to-configure-integrated-cache.md#provision-the-dedicated-gateway)
77-
- [Use Azure Cosmos DB's REST API](/rest/api/cosmos-db-resource-provider/2021-04-01-preview/service/create)
77+
- [Use Azure Cosmos DB's REST API](/rest/api/cosmos-db-resource-provider/2021-04-01-preview/service/create)
7878
- [Azure CLI](/cli/azure/cosmosdb/service?view=azure-cli-latest&preserve-view=true#az-cosmosdb-service-create)
7979
- [ARM template](/azure/templates/microsoft.documentdb/databaseaccounts/services?tabs=bicep)
8080
- Note: You cannot deprovision a dedicated gateway using ARM templates

articles/cosmos-db/how-to-configure-integrated-cache.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: seesharprun
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-sql
77
ms.topic: conceptual
8-
ms.date: 08/02/2022
8+
ms.date: 08/29/2022
99
ms.author: sidandrews
1010
ms.reviewer: jucocchi
1111
---
@@ -25,19 +25,19 @@ This article describes how to provision a dedicated gateway, configure the integ
2525

2626
1. Navigate to an Azure Cosmos DB account in the Azure portal and select the **Dedicated Gateway** tab.
2727

28-
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-tab.png" alt-text="An image that shows how to navigate to the dedicated gateway tab" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-tab.png" border="false":::
28+
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-tab.png" alt-text="An image that shows how to navigate to the dedicated gateway tab" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-tab.png" :::
2929

3030
2. Fill out the **Dedicated gateway** form with the following details:
3131

3232
* **Dedicated Gateway** - Turn on the toggle to **Provisioned**.
3333
* **SKU** - Select a SKU with the required compute and memory size. The integrated cache will use approximately 50% of the memory, and the remaining memory is used for metadata and routing requests to the backend partitions.
3434
* **Number of instances** - Number of nodes. For development purpose, we recommend starting with one node of the D4 size. Based on the amount of data you need to cache and to achieve high availability, you can increase the node size after initial testing.
3535

36-
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-input.png" alt-text="An image that shows sample input settings for creating a dedicated gateway cluster" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-input.png" border="false":::
36+
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-input.png" alt-text="An image that shows sample input settings for creating a dedicated gateway cluster" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-input.png" :::
3737

3838
3. Select **Save** and wait about 5-10 minutes for the dedicated gateway provisioning to complete. When the provisioning is done, you'll see the following notification:
3939

40-
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-notification.png" alt-text="An image that shows how to check if dedicated gateway provisioning is complete" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-notification.png" border="false":::
40+
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-notification.png" alt-text="An image that shows how to check if dedicated gateway provisioning is complete" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-notification.png" :::
4141

4242
## Configuring the integrated cache
4343

@@ -47,7 +47,7 @@ When you create a dedicated gateway, an integrated cache is automatically provis
4747

4848
The updated dedicated gateway connection string is in the **Keys** blade:
4949

50-
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-connection-string.png" alt-text="An image that shows the dedicated gateway connection string" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-connection-string.png" border="false":::
50+
:::image type="content" source="./media/how-to-configure-integrated-cache/dedicated-gateway-connection-string.png" alt-text="An image that shows the dedicated gateway connection string" lightbox="./media/how-to-configure-integrated-cache/dedicated-gateway-connection-string.png" :::
5151

5252
All dedicated gateway connection strings follow the same pattern. Remove `documents.azure.com` from your original connection string and replace it with `sqlx.cosmos.azure.com`. A dedicated gateway will always have the same connection string, even if you remove and reprovision it.
5353

@@ -71,12 +71,12 @@ Configure `MaxIntegratedCacheStaleness`, which is the maximum time in which you
7171

7272
Adjusting the `MaxIntegratedCacheStaleness` is supported in these versions of each SDK:
7373

74-
| SDK | Supported versions | Comment |
75-
| --- | ------------------ | ------- |
76-
| **.NET SDK v3** | *>= 3.19.0-preview* | Currently supported in the preview SDK versions only. |
77-
| **Java SDK v4** | *>= 4.34.0* | - |
78-
| **Node.js SDK** | *>=3.16.0* | - |
79-
| **Python SDK** | *>=4.3.1* | - |
74+
| SDK | Supported versions |
75+
| --- | ------------------ |
76+
| **.NET SDK v3** | *>= 3.30.0* |
77+
| **Java SDK v4** | *>= 4.34.0* |
78+
| **Node.js SDK** | *>=3.17.0* |
79+
| **Python SDK** | *>=4.3.1* |
8080

8181
### [.NET](#tab/dotnet)
8282

articles/cosmos-db/integrated-cache-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: seesharprun
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-sql
77
ms.topic: conceptual
8-
ms.date: 08/02/2022
8+
ms.date: 08/29/2022
99
ms.author: sidandrews
1010
ms.reviewer: jucocchi
1111
---

articles/cosmos-db/integrated-cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: seesharprun
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-sql
77
ms.topic: conceptual
8-
ms.date: 08/02/2022
8+
ms.date: 08/29/2022
99
ms.author: sidandrews
1010
ms.reviewer: jucocchi
1111
---
151 KB
Loading
162 KB
Loading
325 Bytes
Loading
130 KB
Loading

0 commit comments

Comments
 (0)