You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
19
19
20
20
> [!TIP]
21
21
> 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
27
27
## Add/remove regions from your database account
28
28
29
29
> [!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.
31
31
32
32
1. Sign in to [Azure portal](https://portal.azure.com).
33
33
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.
35
35
36
36
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.
37
37
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.
39
39
40
40
1. To save your changes, select **OK**.
41
41
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.":::
43
43
44
44
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.
45
45
46
46
In a multi-region write mode, you can add or remove any region, if you have at least one region.
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.
:::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.":::
53
53
54
54
## <aid="automatic-failover"></a>Enable service-managed failover for your Azure Cosmos DB account
55
55
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.
57
57
58
58
1. From your Azure Cosmos DB account, open the **Replicate data globally** pane.
59
59
60
-
2. At the top of the pane, select **Automatic Failover**.
60
+
1. At the top of the pane, select **Service-Managed Failover**.
61
61
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.":::
63
63
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**.
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
69
69
70
70
## Set failover priorities for your Azure Cosmos DB account
71
71
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.
73
73
74
74
> [!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.
76
76
77
77
1. From your Azure Cosmos DB account, open the **Replicate data globally** pane.
78
78
79
-
2. At the top of the pane, select **Automatic Failover**.
79
+
1. At the top of the pane, select **Service-Managed Failover**.
80
80
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.":::
82
82
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**.
84
84
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.
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
90
90
91
91
## <aid="manual-failover"></a>Perform manual failover on an Azure Cosmos DB account
92
92
93
93
> [!IMPORTANT]
94
94
> The Azure Cosmos DB account must be configured for manual failover for this operation to succeed.
95
95
96
96
> [!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)
98
98
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.
100
100
101
-
2. At the top of the menu, select **Manual Failover**.
101
+
1. At the top of the menu, select **Manual Failover**.
102
102
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.":::
104
104
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.
:::image type="content" source="./media/how-to-manage-database-account/manual-failover.png" alt-text="Screenshot of the manual failover portal menu.":::
110
110
111
111
## Next steps
112
112
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:
114
114
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)
0 commit comments