< Back

Remove-AzureRmSqlDatabaseFromFailoverGroup

Tue Jan 29, 2019 10:09 pm

NAME Remove-AzureRmSqlDatabaseFromFailoverGroup



SYNOPSIS

Removes one or more databases from an Azure SQL Database Failover Group.





SYNTAX

Remove-AzureRmSqlDatabaseFromFailoverGroup [-ResourceGroupName] <String> [-ServerName] <String> [-FailoverGroupName] <String> -Database

<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]> [-DefaultProfile <IAzureContextContainer>]

[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Removes one or more databases from the specified Azure SQL Database Failover Group. The databases and replication relationships are left intact,

but they will no longer be accessible through the Failover Group endpoints.



To obtain database objects with which to populate the '-Database' parameter, use (for example) the Get-AzureRmSqlDatabase cmdlet.



The Failover Group's primary server must be used to execute the command.





PARAMETERS

-Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]>

One or more Azure SQL Databases on the Failover Group's primary server to be removed from the Failover Group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FailoverGroupName <String>

The name of the Azure SQL Database Failover Group.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Force [<SwitchParameter>]

Skip confirmation message for performing the action.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.Commands.Sql,

Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]]





OUTPUTS

System.Object







NOTES









Example 1



PS C:\\> $failoverGroup = Get-AzureRmSqlDatabase -ResourceGroupName rg -ServerName primaryserver -DatabaseName db1 |

Remove-AzureRmSqlDatabaseFromFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg



This command removes one database from a Failover Group by piping it in.





Example 2



PS C:\\> $primaryServer = Get-AzureRmSqlServer -ResourceGroupName rg -ServerName primaryserver

PS C:\\> $failoverGroup = $primaryServer | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName fg -Database ($primaryServer |

Get-AzureRmSqlDatabase)



This command removes all databases from a Failover Group.





Example 3



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

PS C:\\> $databases = Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName rg -ServerName primaryserver -ElasticPoolName pool1

PS C:\\> $failoverGroup = $failoverGroup | Remove-AzureRMSqlDatabaseFromFailoverGroup -Database $databases



This command removes all databases in an Elastic Pool from a Failover Group.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... lovergroup

New-AzureRmSqlDatabaseFailoverGroup

Set-AzureRmSqlDatabaseFailoverGroup

Get-AzureRmSqlDatabaseFailoverGroup

Add-AzureRmSqlDatabaseToFailoverGroup

Switch-AzureRmSqlDatabaseFailoverGroup

Remove-AzureRmSqlDatabaseFailoverGroup

SQL Database Documentation https://docs.microsoft.com/azure/sql-database/