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
Copy file name to clipboardExpand all lines: articles/cosmos-db/how-to-manage-database-account.yml
+25-31Lines changed: 25 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -109,34 +109,36 @@ procedureSection:
109
109
110
110
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/cosmos-db/azure-cosmos-db-account-created-2.png" alt-text="Screenshot shows the Azure Cosmos DB account page." lightbox="~/reusable-content/ce-skilling/azure/media/cosmos-db/azure-cosmos-db-account-created-2.png":::
111
111
- title: |
112
-
Add/remove regions from your database account
112
+
Add or remove regions from your database account
113
113
summary: |
114
-
> [!TIP]
115
-
> 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. Additionally, when removing an existing region, all replication across regions (within [partition sets](./global-distribution.md)) must complete before the region is marked as unavailable.
114
+
> [!NOTE]
115
+
> Adding or removing a region is an asynchronous operation that performs consistency checks and transfers data. This can result in long execution times, possibly many hours, depending on the amount of data. During this time, other operations that need to update the account aren't allowed.
116
+
117
+
> [!IMPORTANT]
118
+
> When you add a region, you're billed for the additional RU/s and storage copied to the region.
116
119
steps:
117
120
- |
118
121
Sign in to [Azure portal](https://portal.azure.com).
119
122
- |
120
123
Go to your Azure Cosmos DB account and select **Replicate data globally** in the resource menu.
121
124
- |
122
-
To add regions, select the hexagons on the map with the **+** label that corresponds to your desired regions. Alternatively, to add a region, select the **+ Add region** option and choose a region from the drop-down menu.
125
+
Select **Manage regions** to open the **Manage regions** pane.
123
126
- |
124
-
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.
125
-
127
+
To add a region, select a region from the **Region** dropdown. If you want to enable availability zone support for the region, select the **Availability zone** checkbox, then select **Add**. To learn more, see [Availability zone support for Azure Cosmos DB](/azure/reliability/reliability-cosmos-db-nosql#availability-zone-support).
126
128
- |
127
-
To save your changes, select **OK**.
129
+
To remove a region, select the delete icon next to the region you want to remove.
128
130
129
-
:::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.":::
131
+
:::image type="content" source="./media/how-to-manage-database-account/add-region.png" alt-text="Screenshot of the Replicate data globally page and the Manage regions pane.":::
130
132
131
-
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.
133
+
In 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.
132
134
133
-
In a multi-region write mode, you can add or remove any region, if you have at least one region.
135
+
In multi-region write mode, you can add or remove any region, as long as at least one region remains.
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.
139
+
In the **Configuration** section of the **Replicate data globally** page, select the **Multi-region writes** checkbox to enable multi-region writes. It will ask for a confirmation to enable this feature. After you enable multi-region writes, all the read regions that you currently have on the account become read and write regions.
138
140
139
-
:::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.":::
141
+
:::image type="content" source="./media/how-to-manage-database-account/configure-multi-region-writes.png" alt-text="Screenshot of the Replicate data globally page, highlighting the Multi-region writes checkbox.":::
140
142
- title: |
141
143
Enable service-managed failover for your Azure Cosmos DB account
142
144
summary: |
@@ -157,20 +159,20 @@ procedureSection:
157
159
- title: |
158
160
Perform forced failover for your Azure Cosmos DB Account
159
161
summary: |
160
-
A forced failover (region offline) enables users to promptly address degraded performance, partial outages, or regional disruptions in a Cosmos DB account. A service-managed failover depends on the service's confirmation and which might take time to activate based on the progression of the outage. A forced failover allows administrators to quickly restore availability for the affected region without waiting for the service-managed failover.
162
+
A forced failover (Offline region) enables users to promptly address degraded performance, partial outages, or regional disruptions in a Cosmos DB account. A service-managed failover depends on the service's confirmation and which might take time to activate based on the progression of the outage. A forced failover allows administrators to quickly restore availability for the affected region without waiting for the service-managed failover.
161
163
steps:
162
164
- |
163
165
From your Azure Cosmos DB account, open the **Replicate data globally** pane.
164
166
- |
165
167
At the top of the pane, select **Offline region**.
166
168
167
-
:::image type="content" source="./media/how-to-manage-database-account/offline-region-failover.png" alt-text="Screenshot that shows the offline region portal menu.":::
169
+
:::image type="content" source="./media/how-to-manage-database-account/offline-region.png" alt-text="Screenshot that shows the offline region portal menu.":::
168
170
- |
169
171
Review the warning message indicating the possibility of data loss due to un-replicated writes not being available in the region that will be promoted to the new write region based on the failover priority.
170
172
- |
171
173
Select the region to be marked offline, check the box titled **I understand and agree to offline the currently selected region**, and click the **Offline region** button.
172
174
173
-
:::image type="content" source="./media/how-to-manage-database-account/offline-region-warning.png" alt-text="Screenshot that shows the offline region warning.":::
175
+
:::image type="content" source="./media/how-to-manage-database-account/offline-region-pane.png" alt-text="Screenshot that shows the offline region warning.":::
174
176
- |
175
177
Once completed, the region with the highest failover priority is promoted to the new write region, while the original write region is marked offline.
176
178
@@ -184,25 +186,21 @@ procedureSection:
184
186
- title: |
185
187
Set failover priorities for your Azure Cosmos DB account
186
188
summary: |
187
-
After an Azure Cosmos DB account is configured for service-managed failover, the failover priority for regions can be changed.
189
+
You can configure failover priorities for the regions in your Azure Cosmos DB account to determine the order in which regions are promoted to the write region during a failover.
188
190
189
-
> [!IMPORTANT]
190
-
> 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.
191
191
steps:
192
192
- |
193
193
From your Azure Cosmos DB account, open the **Replicate data globally** pane.
194
194
- |
195
-
At the top of the pane, select **Service-Managed Failover**.
195
+
At the top of the pane, select **Configure failvoer policy**.
196
196
197
-
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Screenshot showing the Replicate data globally menu.":::
197
+
:::image type="content" source="./media/how-to-manage-database-account/configure-failover-policy.png" alt-text="Screenshot showing the Replicate data globally menu.":::
198
198
- |
199
-
On the **Service-Managed Failover** pane, make sure that **Enable Service-Managed Failover** is set to **ON**.
200
-
- |
201
-
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.
199
+
On the **Configure failover policy** pane, drag and drop the priorities of read regions to be failed over to as needed.
202
200
- |
203
-
Select **Save**.
201
+
Select **OK** to save the failover priority configuration.
204
202
205
-
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
203
+
:::image type="content" source="./media/how-to-manage-database-account/configure-failover-policy-pane.png" alt-text="Screenshot of the Configure failover policy portal menu.":::
206
204
- title: |
207
205
Change write region for your Azure Cosmos DB Account
208
206
summary: |
@@ -222,13 +220,9 @@ procedureSection:
222
220
223
221
:::image type="content" source="./media/how-to-manage-database-account/change-write-region.png" alt-text="Screenshot of the change write region menu.":::
224
222
- |
225
-
The **Change write region** panel provides details to ensure that this operation isn't executed during outage scenarios. Select and acknowledge that this operation is not being performed during regional outages.
226
-
227
-
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-details.png" alt-text="Screenshot of the change write region details.":::
228
-
- |
229
-
Select a new write region and checkbox to acknowledge the operation confirmation. Click **Ok** to perform the operation.
223
+
The **Change write region** panel provides details to ensure that this operation isn't executed during outage scenarios. Select a new write region, acknowledge that this operation isn't being performed during regional outages by selecting the checkboxes, and then select **OK** to perform the operation.
230
224
231
-
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-confirm.png" alt-text="Screenshot of the change write region confirmation.":::
225
+
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-pane.png" alt-text="Screenshot of the change write region confirmation.":::
232
226
233
227
relatedContent:
234
228
- text: Manage Azure Cosmos DB for NoSQL resources using PowerShell
0 commit comments