Skip to content

Commit 22eb7dc

Browse files
authored
Merge pull request #262004 from richagaur/richagaur/burst-capacity-update
cli/ps version update
2 parents 1168fdc + 27af221 commit 22eb7dc

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

articles/cosmos-db/burst-capacity-faq.yml

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,14 @@ sections:
5151
- question: |
5252
How can I enable burst capacity on an account programatically?
5353
answer: |
54-
You can use the [Azure Cosmos DB Resource Provider REST API version `2023-03-15-preview`](/rest/api/cosmos-db-resource-provider/2023-03-15-preview/database-accounts/create-or-update) or a [Resource Manager template with API version `2023-03-01-preview`](/azure/templates/microsoft.documentdb/2023-03-01-preview/databaseaccounts) to set the property `enableBurstCapacity` to true.
54+
You can use the [Azure Cosmos DB Resource Provider REST API version `2023-09-15`](/rest/api/cosmos-db-resource-provider/2023-09-15/database-accounts/create-or-update) or a [Resource Manager template with API version `2023-03-01-preview`](/azure/templates/microsoft.documentdb/2023-03-01-preview/databaseaccounts) to set the property `enableBurstCapacity` to true.
5555
You can also use the Azure CLI or PowerShell.
5656
5757
#### [PowerShell](#tab/azure-powershell)
5858
5959
```azurepowershell
60-
// Add the preview extension 2.0.5-preview or higher
61-
$installParameters = @{
62-
Name = "Az.CosmosDB"
63-
AllowPrerelease = $true
64-
Force = $true
65-
}
66-
Install-Module @installParameters
60+
// Add Azure Cosmos DB extension 1.13.0 or higher
61+
Install-Module -Name Az.CosmosDB -RequiredVersion 1.13.0
6762
6863
// Enable burst capacity on an account
6964
$parameters = @{
@@ -77,9 +72,6 @@ sections:
7772
#### [Azure CLI](#tab/azure-cli)
7873
7974
```azurecli
80-
// Add the preview extension version 0.24.0 or higher
81-
az extension add --name cosmosdb-preview --version 0.24.0
82-
8375
// Enable burst capacity on an account
8476
az cosmosdb update \
8577
--resource-group '<resource-group-name>' \

articles/cosmos-db/burst-capacity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Burst capacity applies only to Azure Cosmos DB accounts using provisioned throug
2222
## How burst capacity works
2323

2424
> [!NOTE]
25-
> The current implementation of burst capacity is subject to change in the future. Usage of burst capacity is subject to system resource availability and is not guaranteed. Azure Cosmos DB may also use burst capacity for background maintenance tasks. If your workload requires consistent throughput beyond what you have provisioned, it's recommended to provision your RU/s accordingly without relying on burst capacity. Before enabling burst capacity, it is also recommended to evaluate if your partition layout can be [merged](merge.md) to permanently give more RU/s per physical partition without relying on burst capacity.
25+
> The current implementation of burst capacity is subject to change in the future. Usage of burst capacity is subject to system resource availability and is **not guaranteed**. Azure Cosmos DB may also use burst capacity for background maintenance tasks. If your workload requires consistent throughput beyond what you have provisioned, it's recommended to provision your RU/s accordingly without relying on burst capacity. Before enabling burst capacity, it is also recommended to evaluate if your partition layout can be [merged](merge.md) to permanently give more RU/s per physical partition without relying on burst capacity.
2626
2727
Let's take an example of a physical partition that has 100 RU/s of provisioned throughput and is idle for 5 minutes. With burst capacity, it can accumulate a maximum of 100 RU/s * 300 seconds = 30,000 RU of burst capacity. The capacity can be consumed at a maximum rate of 3000 RU/s, so if there's a sudden spike in request volume, the partition can burst up to 3000 RU/s for up 30,000 RU / 3000 RU/s = 10 seconds. Without burst capacity, any requests that are consumed beyond the provisioned 100 RU/s would have been rate limited (429).
2828

0 commit comments

Comments
 (0)