Set-AzureRmSqlDatabaseFailoverGroup

Reference

Module:: AzureRM.Sql

Modifies the configuration of an Azure SQL Database Failover Group.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmSqlDatabaseFailoverGroup
   [-ServerName] <String>
   [-FailoverGroupName] <String>
   [-FailoverPolicy <FailoverPolicy>]
   [-GracePeriodWithDataLossHours <Int32>]
   [-AllowReadOnlyFailoverToPrimary <AllowReadOnlyFailoverToPrimary>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

This command modifies the configuration of an Azure SQL Database Failover Group. The Failover Group's primary server should be used to execute the command. To control the set of databases in the group, use 'Add-AzureRmSqlDatabaseToFailoverGroup' and 'Remove-AzureRmSqlDatabaseFromFailoverGroup' instead. During preview of the Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter.

Examples

Example 1

PS C:\> $failoverGroup = Set-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1

Sets a Failover Group's failover policy to 'Automatic.'

Example 2

PS C:\> $failoverGroup = Get-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg | Set-AzureRmSqlDatabaseFailoverGroup -FailoverPolicy Manual

Sets a Failover Group's failover policy to 'Manual' by piping in the Failover Group.

Parameters

-AllowReadOnlyFailoverToPrimary

Whether outages on the secondary server should trigger automatic failover of the read-only endpoint. This feature is not yet supported.

Type:	AllowReadOnlyFailoverToPrimary
Accepted values:	Enabled, Disabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FailoverGroupName

The name of the Azure SQL Database Failover Group.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-FailoverPolicy

The failover policy of the Azure SQL Database Failover Group.

Type:	FailoverPolicy
Accepted values:	Automatic, Manual
Position:	Named
Default value:	Automatic
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GracePeriodWithDataLossHours

Interval before automatic failover is initiated if an outage occurs on the primary server. This indicates that Azure SQL Database will not initiate automatic failover before the grace period expires. Please note that failover operation with AllowDataLoss option might cause data loss due to the nature of asynchronous synchronization.

Type:	Int32
Position:	Named
Default value:	1
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerName

The name of the primary Azure SQL Database Server of the Failover Group.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

AzureSqlFailoverGroupModel