Set-​Azure​Rm​Sql​Database​Secondary

Switches a secondary database to be primary in order to initiate failover.

Syntax

Set-AzureRmSqlDatabaseSecondary
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-DatabaseName] <String>
   -PartnerResourceGroupName <String>
   [-Failover]
   [-AllowDataLoss]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-AzureRmSqlDatabaseSecondary cmdlet switches a secondary database to be primary in order to initiate failover. This cmdlet is designed as a general configuration command, but is currently limited to initiating failover. Specify the AllowDataLoss parameter to initiate a force failover during an outage. You do not have to specify this parameter when you perform a planned operation, such as recovery drill. In the latter case, the secondary database is synchronized with the primary before it is switched.

Examples

1:

Required Parameters

-DatabaseName

Specifies the name of the Azure SQL Database Secondary.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Failover

Indicates that this operation is a failover.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PartnerResourceGroupName

Specifies the name of the resource group to which the partner Azure SQL Database is assigned.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group to which the Azure SQL Database Secondary is assigned.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerName

Specifies the name of the SQL Server that hosts the Azure SQL Database Secondary.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AllowDataLoss

Indicates that this failover operation permits data loss.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

You can pipe instances of the Database object for the secondary database to fail over and make the primary database to this cmdlet.

Outputs

This cmdlet returns a ReplicationLink.