Skip to content

Commit df21dfb

Browse files
authored
Merge pull request #229960 from JustPies/jprefresh-3-7
Freshness Pass User Story: 2036619 Learn how to manage database accounts in Azure Cosmos DB
2 parents 61cb7a5 + 6c46e1f commit df21dfb

File tree

6 files changed

+36
-37
lines changed

6 files changed

+36
-37
lines changed
Lines changed: 36 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: Learn how to manage database accounts in Azure Cosmos DB
3-
description: Learn how to manage Azure Cosmos DB resources by using the Azure portal, PowerShell, CLI, and Azure Resource Manager templates
2+
title: Manage an Azure Cosmos DB account by using the Azure portal
3+
description: Learn how to manage Azure Cosmos DB resources by using the Azure portal, PowerShell, CLI, and Azure Resource Manager templates.
44
author: seesharprun
55
ms.service: cosmos-db
66
ms.subservice: nosql
77
ms.custom: ignite-2022
88
ms.topic: how-to
9-
ms.date: 09/13/2021
9+
ms.date: 03/08/2023
1010
ms.author: sidandrews
1111
ms.reviewer: mjbrown
1212
---
1313

14-
# Manage an Azure Cosmos DB account using the Azure portal
14+
# Manage an Azure Cosmos DB account by using the Azure portal
1515

1616
[!INCLUDE[NoSQL, MongoDB, Cassandra, Gremlin, Table](includes/appliesto-nosql-mongodb-cassandra-gremlin-table.md)]
1717

18-
This article describes how to manage various tasks on an Azure Cosmos DB account using the Azure portal.
18+
This article describes how to manage various tasks on an Azure Cosmos DB account by using the Azure portal.
1919

2020
> [!TIP]
2121
> Azure Cosmos DB can also be managed with other Azure management clients including [Azure PowerShell](manage-with-powershell.md), [Azure CLI](sql/manage-with-cli.md), [Azure Resource Manager templates](./manage-with-templates.md), and [Bicep](sql/manage-with-bicep.md).
@@ -27,92 +27,91 @@ This article describes how to manage various tasks on an Azure Cosmos DB account
2727
## Add/remove regions from your database account
2828

2929
> [!TIP]
30-
> When a new region is added, all data must be fully replicated and committed into the new region before the region is marked as available. The amount of time this operation takes will depend upon how much data is stored within the account. If an [asynchronous throughput scaling operation](scaling-provisioned-throughput-best-practices.md#background-on-scaling-rus) is in progress, the throughput scale-up operation will be paused and will resume automatically when the add/remove region operation is complete.
30+
> When a new region is added, all data must be fully replicated and committed into the new region before the region is marked as available. The amount of time this operation takes depends upon how much data is stored within the account. If an [asynchronous throughput scaling operation](scaling-provisioned-throughput-best-practices.md#background-on-scaling-rus) is in progress, the throughput scale-up operation is paused and resumes automatically when the add/remove region operation is complete.
3131
3232
1. Sign in to [Azure portal](https://portal.azure.com).
3333

34-
1. Go to your Azure Cosmos DB account, and select **Replicate data globally** in the resource menu.
34+
1. Go to your Azure Cosmos DB account and select **Replicate data globally** in the resource menu.
3535

3636
1. To add regions, select the hexagons on the map with the **+** label that corresponds to your desired region(s). Alternatively, to add a region, select the **+ Add region** option and choose a region from the drop-down menu.
3737

38-
1. To remove regions, clear one or more regions from the map by selecting the blue hexagons with check marks. Or select the "wastebasket" (🗑) icon next to the region on the right side.
38+
1. To remove regions, clear one or more regions from the map by selecting the blue hexagons with check marks. You can also select the "wastebasket" (🗑) icon next to the region on the right side.
3939

4040
1. To save your changes, select **OK**.
4141

42-
:::image type="content" source="./media/how-to-manage-database-account/add-region.png" alt-text="Add or remove regions menu":::
42+
:::image type="content" source="./media/how-to-manage-database-account/add-region.png" alt-text="Screenshot of the Replicate data globally menu, highlighting a region.":::
4343

4444
In a single-region write mode, you can't remove the write region. You must fail over to a different region before you can delete the current write region.
4545

4646
In a multi-region write mode, you can add or remove any region, if you have at least one region.
4747

4848
## <a id="configure-multiple-write-regions"></a>Configure multiple write-regions
4949

50-
Open the **Replicate Data Globally** tab and select **Enable** to enable multi-region writes. After you enable multi-region writes, all the read regions that you currently have on the account will become read and write regions.
50+
Open the **Replicate data globally** tab and select **Enable** to enable multi-region writes. After you enable multi-region writes, all the read regions that you currently have on the account will become read and write regions.
5151

52-
:::image type="content" source="./media/how-to-manage-database-account/single-to-multi-master.png" alt-text="Azure Cosmos DB account configures multi-region writes screenshot":::
52+
:::image type="content" source="./media/how-to-manage-database-account/single-to-multi-master.png" alt-text="Screenshot of the Replicate data globally menu, highlighting Configure regions and Save.":::
5353

5454
## <a id="automatic-failover"></a>Enable service-managed failover for your Azure Cosmos DB account
5555

56-
The Service-Managed failover option allows Azure Cosmos DB to fail over to the region with the highest failover priority with no user action should a region become unavailable. When service-managed failover is enabled, region priority can be modified. Account must have two or more regions to enable service-managed failover.
56+
The Service-Managed failover option allows Azure Cosmos DB to fail over to the region with the highest failover priority with no user action should a region become unavailable. When service-managed failover is enabled, region priority can be modified. Your account must have two or more regions to enable service-managed failover.
5757

5858
1. From your Azure Cosmos DB account, open the **Replicate data globally** pane.
5959

60-
2. At the top of the pane, select **Automatic Failover**.
60+
1. At the top of the pane, select **Service-Managed Failover**.
6161

62-
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Replicate data globally menu":::
62+
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Screenshot that shows the replicate data globally menu.":::
6363

64-
3. On the **Automatic Failover** pane, make sure that **Enable Automatic Failover** is set to **ON**.
64+
1. On the **Service-Managed Failover** pane, make sure that **Enable Service-Managed Failover** is set to **ON**.
6565

66-
4. Select **Save**.
66+
1. Select **Save**.
6767

68-
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Automatic failover portal menu":::
68+
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
6969

7070
## Set failover priorities for your Azure Cosmos DB account
7171

72-
After an Azure Cosmos DB account is configured for automatic failover, the failover priority for regions can be changed.
72+
After an Azure Cosmos DB account is configured for service-managed failover, the failover priority for regions can be changed.
7373

7474
> [!IMPORTANT]
75-
> You cannot modify the write region (failover priority of zero) when the account is configured for service-managed failover. To change the write region, you must disable service-managed failover and do a manual failover.
75+
> You can't modify the write region (failover priority of zero) when the account is configured for service-managed failover. To change the write region, you must disable service-managed failover and do a manual failover.
7676
7777
1. From your Azure Cosmos DB account, open the **Replicate data globally** pane.
7878

79-
2. At the top of the pane, select **Automatic Failover**.
79+
1. At the top of the pane, select **Service-Managed Failover**.
8080

81-
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Replicate data globally menu":::
81+
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Screenshot showing the Replicate data globally menu.":::
8282

83-
3. On the **Automatic Failover** pane, make sure that **Enable Automatic Failover** is set to **ON**.
83+
1. On the **Service-Managed Failover** pane, make sure that **Enable Automatic Failover** is set to **ON**.
8484

85-
4. To modify the failover priority, drag the read regions via the three dots on the left side of the row that appear when you hover over them.
85+
1. To modify the failover priority, drag the read regions via the three dots on the left side of the row that appear when you hover over them.
8686

87-
5. Select **Save**.
87+
1. Select **Save**.
8888

89-
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Automatic failover portal menu":::
89+
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
9090

9191
## <a id="manual-failover"></a>Perform manual failover on an Azure Cosmos DB account
9292

9393
> [!IMPORTANT]
9494
> The Azure Cosmos DB account must be configured for manual failover for this operation to succeed.
9595
9696
> [!NOTE]
97-
> If you perform a manual failover operation while an [asynchronous throughput scaling operation](scaling-provisioned-throughput-best-practices.md#background-on-scaling-rus) is in progress, the throughput scale-up operation will be paused. It will resume automatically when the failover operation is complete.
97+
> If you perform a manual failover operation while an asynchronous throughput scaling operation is in progress, the throughput scale-up operation will be paused. It resumes automatically when the failover operation is complete. For more information, see [Best practices for scaling provisioned throughput (RU/s)](scaling-provisioned-throughput-best-practices.md#background-on-scaling-rus)
9898
99-
1. Go to your Azure Cosmos DB account, and open the **Replicate data globally** menu.
99+
1. Go to your Azure Cosmos DB account and open the **Replicate data globally** menu.
100100

101-
2. At the top of the menu, select **Manual Failover**.
101+
1. At the top of the menu, select **Manual Failover**.
102102

103-
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Replicate data globally menu":::
103+
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Screenshot of the Replicate data globally menu.":::
104104

105-
3. On the **Manual Failover** menu, select your new write region. Select the check box to indicate that you understand this option changes your write region.
105+
1. On the **Manual Failover** menu, select your new write region. Select the check box to indicate that you understand this option changes your write region.
106106

107-
4. To trigger the failover, select **OK**.
107+
1. To trigger the failover, select **OK**.
108108

109-
:::image type="content" source="./media/how-to-manage-database-account/manual-failover.png" alt-text="Manual failover portal menu":::
109+
:::image type="content" source="./media/how-to-manage-database-account/manual-failover.png" alt-text="Screenshot of the manual failover portal menu.":::
110110

111111
## Next steps
112112

113-
For more information and examples on how to manage the Azure Cosmos DB account as well as database and containers, read the following articles:
113+
For more information and examples on how to manage the Azure Cosmos DB account as well as databases and containers, read the following articles:
114114

115-
* [Manage Azure Cosmos DB using Azure PowerShell](manage-with-powershell.md)
116-
* [Manage Azure Cosmos DB using Azure CLI](sql/manage-with-cli.md)
117-
* [Manage Azure Cosmos DB using Azure Resource Management templates](./manage-with-templates.md)
118-
* [Manage Azure Cosmos DB using Bicep](sql/manage-with-bicep.md)
115+
* [Manage Azure Cosmos DB for NoSQL resources using PowerShell](manage-with-powershell.md)
116+
* [Manage Azure Cosmos DB for NoSQL resources using Azure CLI](sql/manage-with-cli.md)
117+
* [Manage Azure Cosmos DB for NoSQL resources with Azure Resource Manager templates](./manage-with-templates.md)
46 KB
Loading
20.6 KB
Loading
14.2 KB
Loading
34.5 KB
Loading
-2.98 KB
Loading

0 commit comments

Comments
 (0)