Skip to content

setup-geodr-and-failover-database-powershell.md

Latest commit

 

History

History
62 lines (47 loc) · 3.53 KB

setup-geodr-and-failover-database-powershell.md

File metadata and controls

62 lines (47 loc) · 3.53 KB
title PowerShell: Configure Active Geo-Replication
description Use an Azure PowerShell example script to set up active geo-replication for Azure SQL Database and fail it over.
author AbdullahMSFT
ms.author amamun
ms.reviewer wiassaf, mathoma
ms.date 06/10/2025
ms.service azure-sql-database
ms.subservice high-availability
ms.topic sample
ms.custom
sqldbrb=1
devx-track-azurepowershell
ms.devlang powershell

Use PowerShell to configure active geo-replication for a database in Azure SQL Database

[!INCLUDEappliesto-sqldb]

This Azure PowerShell script example configures active geo-replication for a database in Azure SQL Database and fails it over to a secondary replica of the database.

[!INCLUDE quickstarts-free-trial-note] [!INCLUDE updated-for-az] [!INCLUDE cloud-shell-try-it.md]

If you choose to install and use PowerShell locally, this tutorial requires Az PowerShell 1.4.0 or later. If you need to upgrade, see Install Azure PowerShell module. If you are running PowerShell locally, you also need to run Connect-AzAccount to create a connection with Azure.

Sample scripts

[!code-powershell-interactivemain]

Clean up deployment

Use the following command to remove the resource group and all resources associated with it.

Remove-AzResourceGroup -ResourceGroupName $primaryresourcegroupname
Remove-AzResourceGroup -ResourceGroupName $secondaryresourcegroupname

Script explanation

This script uses the following commands. Each command in the table links to command-specific documentation.

Command Notes
New-AzResourceGroup Creates a resource group in which all resources are stored.
New-AzSqlServer Creates a server that hosts databases and elastic pools.
New-AzSqlElasticPool Creates an elastic pool.
Set-AzSqlDatabase Updates database properties or moves a database into, out of, or between elastic pools.
New-AzSqlDatabaseSecondary Creates a secondary database for an existing database and starts data replication.
Get-AzSqlDatabase Gets one or more databases.
Set-AzSqlDatabaseSecondary Switches a secondary database to be primary to initiate failover.
Get-AzSqlDatabaseReplicationLink Gets the geo-replication links between an Azure SQL Database and a resource group or logical SQL server.
Remove-AzSqlDatabaseSecondary Terminates data replication between a database and the specified secondary database.
Remove-AzResourceGroup Deletes a resource group including all nested resources.

Related content