dedicated gateway ga updates

jcocchi · jcocchi · commit 184cd39cce17 · 2022-07-25T23:48:22.000-07:00
diff --git a/articles/cosmos-db/dedicated-gateway.md b/articles/cosmos-db/dedicated-gateway.md
@@ -5,12 +5,12 @@ author: seesharprun
 ms.service: cosmos-db
 ms.subservice: cosmosdb-sql
 ms.topic: conceptual
-ms.date: 11/08/2021
+ms.date: 07/25/2022
 ms.author: sidandrews
 ms.reviewer: jucocchi
 ---
 
-# Azure Cosmos DB dedicated gateway - Overview (Preview)
+# Azure Cosmos DB dedicated gateway - Overview
 [!INCLUDE[appliesto-sql-api](includes/appliesto-sql-api.md)]
 
 A dedicated gateway is server-side compute that is a front-end to your Azure Cosmos DB account. When you connect to the dedicated gateway, it both routes requests and caches data. Like provisioned throughput, the dedicated gateway is billed hourly.
@@ -68,8 +68,6 @@ Dedicated gateway nodes are independent from one another. When you provision mul
 
 For development, we recommend starting with one node but for production, you should provision three or more nodes for high availability. [Learn how to provision a dedicated gateway cluster with an integrated cache](how-to-configure-integrated-cache.md). Provisioning multiple dedicated gateway nodes allows the dedicated gateway cluster to continue to route requests and serve cached data, even when one of the dedicated gateway nodes is unavailable.
 
-Because it is in public preview, the dedicated gateway does not have an availability SLA. However, you should generally expect comparable availability to the rest of your Azure Cosmos DB account.
-
 The dedicated gateway is available in the following sizes:
 
 | **Sku Name** | **vCPU** | **Memory**  |
@@ -79,7 +77,7 @@ The dedicated gateway is available in the following sizes:
 | **D16s**     | **16**   | **64 GB** |
 
 > [!NOTE]
-> Once created, you can't modify the size of the dedicated gateway nodes. However, you can add or remove nodes.
+> Once created, you can add or remove dedicated gateway nodes, but you can't modify the size of the nodes. To change the size of your dedicated gateway nodes you can deprovision the cluster and provision it again in a different size.
 
 There are many different ways to provision a dedicated gateway:
 
@@ -93,42 +91,40 @@ There are many different ways to provision a dedicated gateway:
 
 When you provision a dedicated gateway cluster in multi-region accounts, identical dedicated gateway clusters are provisioned in each region. For example, consider an Azure Cosmos DB account in East US and North Europe. If you provision a dedicated gateway cluster with two D8 nodes in this account, you'd have four D8 nodes in total - two in East US and two in North Europe. You don't need to explicitly configure dedicated gateways in each region and your connection string remains the same. There are also no changes to best practices for performing failovers.
 
-> [!NOTE]
-> You cannot provision a dedicated gateway cluster in accounts with availability zones enabled
-
 Like nodes within a cluster, dedicated gateway nodes across regions are independent. It's possible that the cached data in each region will be different, depending on the recent reads or writes to that region.
 
 ## Limitations
 
-The dedicated gateway has the following limitations during the public preview:
+The dedicated gateway has the following limitations:
 
-- Dedicated gateways are only supported on SQL API accounts.
-- You can't provision a dedicated gateway in Azure Cosmos DB accounts with [IP firewalls](how-to-configure-firewall.md) or [Private Link](how-to-configure-private-endpoints.md) configured.
-- You can't provision a dedicated gateway in an Azure Cosmos DB account in a [Virtual Network (Vnet)](how-to-configure-vnet-service-endpoint.md)
-- You can't provision a dedicated gateway in Azure Cosmos DB accounts with [availability zones](../availability-zones/az-region.md).
+- Dedicated gateways are only supported on SQL API accounts
 - You can't use [role-based access control (RBAC)](how-to-setup-rbac.md) to authenticate data plane requests routed through the dedicated gateway
 
 The dedicated gateway blade is hidden on Azure Cosmos DB accounts with IP firewalls, Vnet, Private Link, or availability zones.
 
 ## Supported regions
 
-The dedicated gateway is in public preview and isn't supported in every Azure region yet. Throughout the public preview, we'll be adding new capacity. We won't have region restrictions when the dedicated gateway is generally available.
+The dedicated gateway isn't supported in every Azure region yet.
 
 Current list of supported Azure regions:
 
 | **Americas** | **Europe and Africa**  | **Asia Pacific**  |
 | ------------ | -------- | ----------- | 
 | Brazil South      | France Central    | Australia Central |
 | Canada Central  | France South    | Australia Central 2 |
-| Canada East     | Germany North   | Australia Southeast |
-| Central US     | Germany West Central   | Central India |
-| East US     | North Europe   | East Asia |
-| East US 2     | Switzerland North   | Japan West |
-| North Central US     | UK South   | Korea Central |
-| South Central US     | UK West   | Korea South |
-| West Central US     | West Europe   | Southeast Asia |
-| West US     |   | UAE Central |
-| West US 2     |    | West India |
+| Canada East     | Germany North   | Australia East |
+| Central US | Germany West Central | Australia Southeast |
+| Central US EUAP | North Europe | Central India |
+| East US | Norway East | East Asia |
+| East US 2 | Norway West | Japan West |
+| East US 2 EUAP | South Africa North | Japan East |
+| North Central US | Switzerland North | Korea Central |
+| South Central US | Switzerland West | Korea South |
+| West Central US | UAE Central | Southeast Asia |
+| West US | UAE North | West India |
+| West US 2 | UK South |  |
+|   | UK West | |
+|      | West Europe |  |
 
 
 ## Next steps
diff --git a/articles/cosmos-db/how-to-configure-integrated-cache.md b/articles/cosmos-db/how-to-configure-integrated-cache.md
@@ -5,12 +5,12 @@ author: seesharprun
 ms.service: cosmos-db
 ms.subservice: cosmosdb-sql
 ms.topic: conceptual
-ms.date: 09/28/2021
+ms.date: 07/25/2022
 ms.author: sidandrews
 ms.reviewer: jucocchi
 ---
 
-# How to configure the Azure Cosmos DB integrated cache (Preview)
+# How to configure the Azure Cosmos DB integrated cache
 [!INCLUDE[appliesto-sql-api](includes/appliesto-sql-api.md)]
 
 This article describes how to provision a dedicated gateway, configure the integrated cache, and connect your application. 
@@ -58,7 +58,7 @@ This article describes how to provision a dedicated gateway, configure the integ
 > [!NOTE]
 > If you are using the latest .NET or Java SDK version, the default connection mode is direct mode. In order to use the integrated cache, you must override this default.
 
-If you're using the Java SDK, you must also manually set [contentResponseOnWriteEnabled](/java/api/com.azure.cosmos.cosmosclientbuilder.contentresponseonwriteenabled?view=azure-java-stable&preserve-view=true) to `true` within the `CosmosClientBuilder`. If you're using any other SDK, this value already defaults to `true`, so you don't need to make any changes.
+4. If you're using the Java SDK, you must also manually set [contentResponseOnWriteEnabled](/java/api/com.azure.cosmos.cosmosclientbuilder.contentresponseonwriteenabled?view=azure-java-stable&preserve-view=true) to `true` within the `CosmosClientBuilder`. If you're using any other SDK, this value already defaults to `true`, so you don't need to make any changes.
 
 ## Adjust request consistency
 
@@ -85,8 +85,13 @@ FeedIterator<Food> myQuery = container.GetItemQueryIterator<Food>(new QueryDefin
 );
 ```
 
-> [!NOTE]
-> Currently, you can only adjust the MaxIntegratedCacheStaleness using the latest [.NET](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.17.0-preview) and [Java](https://mvnrepository.com/artifact/com.azure/azure-cosmos/4.16.0-beta.1) preview SDK's.
+Adjusting the `MaxIntegratedCacheStaleness` is supported in these versions of each SDK:
+| SDK | Supported versions | Comment
+| --- | --- | --- |
+| **.NET SDK v3** | *>= 3.19.0-preview* | Currently supported in the preview SDK versions only. |
+| **Java SDK v4** | *>= 4.16.0-beta* | Currently supported in the preview SDK versions only. |
+| **Node.js SDK** | *>=3.16.0* | |
+| **Python SDK** | *>=4.3.0b3* | |
 
 ## Verify cache hits
 
@@ -95,7 +100,7 @@ Finally, you can restart your application and verify integrated cache hits for r
 For a read request (point read or query) to utilize the integrated cache, **all** of the following criteria must be true:
 
 -	Your client connects to the dedicated gateway endpoint
--  Your client uses gateway mode (Python and Node.js SDK's always use gateway mode)
+-  Your client uses gateway mode (Python and Node.js SDKs always use gateway mode)
 -	The consistency for the request must be set to session or eventual
 
 > [!NOTE]
diff --git a/articles/cosmos-db/how-to-configure-private-endpoints.md b/articles/cosmos-db/how-to-configure-private-endpoints.md
@@ -53,7 +53,7 @@ Use the following steps to create a private endpoint for an existing Azure Cosmo
     | Subscription| Select your subscription. |
     | Resource type | Select **Microsoft.AzureCosmosDB/databaseAccounts**. |
     | Resource |Select your Azure Cosmos account. |
-    |Target sub-resource |Select the Azure Cosmos DB API type that you want to map. This defaults to only one choice for the SQL, MongoDB, and Cassandra APIs. For the Gremlin and Table APIs, you can also choose **Sql** because these APIs are interoperable with the SQL API. |
+    |Target sub-resource |Select the Azure Cosmos DB API type that you want to map. This defaults to only one choice for the SQL, MongoDB, and Cassandra APIs. For the Gremlin and Table APIs, you can also choose **Sql** because these APIs are interoperable with the SQL API. If you have a [dedicated gateway](./dedicated-gateway.md) provisioned for a SQL API account, you will also see an option for **SqlDedicated**. |
     |||
 
 1. Select **Next: Configuration**.
@@ -76,11 +76,12 @@ When you have approved Private Link for an Azure Cosmos account, in the Azure po
 
 ## <a id="private-zone-name-mapping"></a>API types and private zone names
 
-The following table shows the mapping between different Azure Cosmos account API types, supported sub-resources, and the corresponding private zone names. You can also access the Gremlin and Table API accounts through the SQL API, so there are two entries for these APIs.
+The following table shows the mapping between different Azure Cosmos account API types, supported sub-resources, and the corresponding private zone names. You can also access the Gremlin and Table API accounts through the SQL API, so there are two entries for these APIs. There is also an extra entry for the SQL API for accounts using the [dedicated gateway](./dedicated-gateway.md). 
 
 |Azure Cosmos account API type  |Supported sub-resources (or group IDs) |Private zone name  |
 |---------|---------|---------|
 |Sql    |   Sql      | privatelink.documents.azure.com   |
+|Sql    |   SqlDedicated      | privatelink.sqlx.cosmos.azure.com   |
 |Cassandra    | Cassandra        |  privatelink.cassandra.cosmos.azure.com    |
 |Mongo   |  MongoDB       |  privatelink.mongo.cosmos.azure.com    |
 |Gremlin     | Gremlin        |  privatelink.gremlin.cosmos.azure.com   |
diff --git a/articles/cosmos-db/integrated-cache-faq.md b/articles/cosmos-db/integrated-cache-faq.md
@@ -5,7 +5,7 @@ author: seesharprun
 ms.service: cosmos-db
 ms.subservice: cosmosdb-sql
 ms.topic: conceptual
-ms.date: 09/20/2021
+ms.date: 07/25/2022
 ms.author: sidandrews
 ms.reviewer: jucocchi
 ---
@@ -46,11 +46,11 @@ If your app previously used gateway mode with the standard gateway, the integrat
 
 ### Does the Azure Cosmos DB availability SLA extend to the dedicated gateway and integrated cache?
 
-We will have an availability SLA/SLO on the dedicated gateway (and therefore the integrated cache) once the feature is generally available. For scenarios that require high availability, you should provision 3x the number of dedicated gateway instances needed. For example, if one dedicated gateway node is needed in production, you should provision two additional dedicated gateway nodes to account for possible downtime or outages.
+For scenarios that require high availability and in order to be covered by the Azure Cosmos DB availability SLA, you should provision 3x the number of dedicated gateway instances needed. For example, if one dedicated gateway node is needed in production, you should provision two additional dedicated gateway nodes to account for possible downtime or outages. Additionally, [ensure your dedicated gateway has enough nodes](./integrated-cache.md#i-want-to-understand-if-i-need-to-add-more-dedicated-gateway-nodes) to serve your workload.
 
 ### The integrated cache is only available for SQL (Core) API right now. Are you planning on releasing it for other APIs as well?
 
-Expanding the integrated cache beyond SQL API is planned on the long-term roadmap but beyond the initial public preview of the integrated cache.
+Expanding the integrated cache beyond SQL API is planned on the long-term roadmap but beyond the initial scope of the integrated cache.
 
 ### What consistency does the integrated cache support?
 
diff --git a/articles/cosmos-db/integrated-cache.md b/articles/cosmos-db/integrated-cache.md
@@ -5,12 +5,12 @@ author: seesharprun
 ms.service: cosmos-db
 ms.subservice: cosmosdb-sql
 ms.topic: conceptual
-ms.date: 09/28/2021
+ms.date: 07/25/2022
 ms.author: sidandrews
 ms.reviewer: jucocchi
 ---
 
-# Azure Cosmos DB integrated cache - Overview (Preview)
+# Azure Cosmos DB integrated cache - Overview
 [!INCLUDE[appliesto-sql-api](includes/appliesto-sql-api.md)]
 
 The Azure Cosmos DB integrated cache is an in-memory cache that helps you ensure manageable costs and low latency as your request volume grows. The integrated cache is easy to set up and you don’t need to spend time writing custom code for cache invalidation or managing backend infrastructure. Your integrated cache uses a [dedicated gateway](dedicated-gateway.md) within your Azure Cosmos DB account. The integrated cache is the first of many Azure Cosmos DB features that will utilize a dedicated gateway for improved performance. You can choose from three possible dedicated gateway sizes based on the number of cores and memory needed for your workload.
@@ -120,22 +120,21 @@ To better understand the `MaxIntegratedCacheStaleness` parameter, consider the f
 | t = 40 sec | Run Query B with MaxIntegratedCacheStaleness = 60 seconds | Return results from integrated cache (0 RU charge)           |
 | t = 50 sec | Run Query B with MaxIntegratedCacheStaleness = 20 seconds | Return results from backend database (normal RU charges) and refresh cache |
 
-> [!NOTE]
-> Customizing `MaxIntegratedCacheStaleness` is only supported in the latest .NET and Java preview SDK's.
-
 [Learn to configure the `MaxIntegratedCacheStaleness`.](how-to-configure-integrated-cache.md#adjust-maxintegratedcachestaleness)
 
 ## Metrics
 
 When using the integrated cache, it is helpful to monitor some key metrics. The integrated cache metrics include:
 
-- `DedicatedGatewayAverageCpuUsage` - Average CPU usage across dedicated gateway nodes.
-- `DedicatedGatewayMaxCpuUsage` - Maximum CPU usage across dedicated gateway nodes.
-- `DedicatedGatewayAverageMemoryUsage` - Average memory usage across dedicated gateway nodes, which are used for both routing requests and caching data.
-- `DedicatedGatewayRequests` - Total number of dedicated gateway requests across all dedicated gateway instances.
-- `IntegratedCacheEvictedEntriesSize` – The average amount of data evicted due to LRU from the integrated cache across dedicated gateway nodes. This value does not include data that expired due to exceeding the `MaxIntegratedCacheStaleness` time.
-- `IntegratedCacheItemExpirationCount` - The number of items that are evicted from the integrated cache due to cached point reads exceeding the `MaxIntegratedCacheStaleness` time. This value is an average of integrated cache instances across all dedicated gateway nodes.
-- `IntegratedCacheQueryExpirationCount` - The  number of queries that are evicted from the integrated cache due to cached queries exceeding the `MaxIntegratedCacheStaleness` time. This value is an average of integrated cache instances across all dedicated gateway nodes.
+- `DedicatedGatewayCPUUsage` - CPU usage with Avg, Max, or Min Aggregation types for data across all dedicated gateway nodes.
+- `DedicatedGatewayAverageCPUUsage` - (Deprecated) Average CPU usage across all dedicated gateway nodes.
+- `DedicatedGatewayMaximumCPUUsage` - (Deprecated) Maximum CPU usage across all dedicated gateway nodes.
+- `DedicatedGatewayMemoryUsage` - Memory usage with Avg, Max, or Min Aggregation types for data across all dedicated gateway nodes. 
+- `DedicatedGatewayAverageMemoryUsage` - (Deprecated) Average memory usage across all dedicated gateway nodes.
+- `DedicatedGatewayRequests` - Total number of dedicated gateway requests across all dedicated gateway nodes.
+- `IntegratedCacheEvictedEntriesSize` – The average amount of data evicted from the integrated cache due to LRU across all dedicated gateway nodes. This value does not include data that expired due to exceeding the `MaxIntegratedCacheStaleness` time.
+- `IntegratedCacheItemExpirationCount` - The average number of items that are evicted from the integrated cache due to cached point reads exceeding the `MaxIntegratedCacheStaleness` time across all dedicated gateway nodes. 
+- `IntegratedCacheQueryExpirationCount` - The average number of queries that are evicted from the integrated cache due to cached queries exceeding the `MaxIntegratedCacheStaleness` time across all dedicated gateway nodes.
 - `IntegratedCacheItemHitRate` – The proportion of point reads that used the integrated cache (out of all point reads routed through the dedicated gateway with session or eventual consistency). This value is an average of integrated cache instances across all dedicated gateway nodes.
 - `IntegratedCacheQueryHitRate` – The proportion of queries that used the integrated cache (out of all queries routed through the dedicated gateway with session or eventual consistency). This value is an average of integrated cache instances across all dedicated gateway nodes.
 
@@ -171,7 +170,7 @@ If most data is evicted from the cache due to exceeding the `MaxIntegratedCacheS
 
 ### I want to understand if I need to add more dedicated gateway nodes
 
-In some cases, if latency is unexpectedly high, you may need more dedicated gateway nodes rather than bigger nodes. Check the `DedicatedGatewayMaxCpuUsage` and `DedicatedGatewayAverageMemoryUsage` to determine if adding more dedicated gateway nodes would reduce latency. It's good to keep in mind that since all instances of the integrated cache are independent from one another, adding more dedicated gateway nodes won't reduce the `IntegratedCacheEvictedEntriesSize`. Adding more nodes will improve the request volume that your dedicated gateway cluster can handle, though.
+In some cases, if latency is unexpectedly high, you may need more dedicated gateway nodes rather than bigger nodes. Check the `DedicatedGatewayCPUUsage` and `DedicatedGatewayMemoryUsage` to determine if adding more dedicated gateway nodes would reduce latency. It's good to keep in mind that since all instances of the integrated cache are independent from one another, adding more dedicated gateway nodes won't reduce the `IntegratedCacheEvictedEntriesSize`. Adding more nodes will improve the request volume that your dedicated gateway cluster can handle, though.
 
 ## Next steps
 
