Skip to content

add-database-to-failover-group-powershell.md

Latest commit

 

History

History
62 lines (46 loc) · 3.24 KB

add-database-to-failover-group-powershell.md

File metadata and controls

62 lines (46 loc) · 3.24 KB
title PowerShell: Add a database to an auto-failover group
description Use an Azure PowerShell example script to create a database in Azure SQL Database, add it to an auto-failover group, and test failover.
author AbdullahMSFT
ms.author amamun
ms.reviewer wiassaf, mathoma
ms.date 07/16/2019
ms.service sql-database
ms.subservice high-availability
ms.topic sample
ms.custom
sqldbrb=1
devx-track-azurepowershell
ms.devlang PowerShell

Use PowerShell to add a database to a failover group

[!INCLUDEappliesto-sqldb]

This PowerShell script example creates a single database in Azure SQL Database, creates a failover group, adds the database to it, and tests failover.

[!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 $resourceGroupName

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.
New-AzSqlServerFirewallRule Creates a server-level firewall rule for a server.
New-AzSqlDatabase Creates a new database.
New-AzSqlDatabaseFailoverGroup Creates a new failover group.
Get-AzSqlDatabase Gets one or more databases.
Add-AzSqlDatabaseToFailoverGroup Adds one or more databases to a failover group.
Get-AzSqlDatabaseFailoverGroup Gets or lists failover groups.
Switch-AzSqlDatabaseFailoverGroup Executes a failover of a failover group.
Remove-AzResourceGroup Removes a resource group

Next steps

For more information on Azure PowerShell, see Azure PowerShell documentation.

Additional SQL Database PowerShell script samples can be found in the Azure SQL Database PowerShell scripts.