Remove-DatabaseFromAvailabilityGroup

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Removes one or more SharePoint databases from an availability group in SQL Server.

Syntax

Remove-DatabaseFromAvailabilityGroup
      [-AGName] <String>
      [-AssignmentCollection <SPAssignmentCollection>]
      -DatabaseName <String>
      [-Force]
      [-KeepSecondaryData]
      [<CommonParameters>]

Remove-DatabaseFromAvailabilityGroup
      [-AGName] <String>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Force]
      [-KeepSecondaryData]
      [-ProcessAllDatabases]
      [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see https://msdn.microsoft.com/library/dd878348(VS.85).aspx.

Examples

------------------EXAMPLE------------------

Remove-DatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content

This example removes the availability group named "MyAvailabilityGroup" from the WSS_Content database.

Parameters

-AGName

The name of the availability group from which the databases are being removed.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DatabaseName

The name of the database to be removed from the availability group.

NOTE: This parameter should not be used in conjunction with the ProcessAllDatabases parameter.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Force

Forces a remove from the group.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-KeepSecondaryData

Specifies that copies of the databases on the replicas in the availability group will not be deleted. Otherwise, those database copies will be dropped.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProcessAllDatabases

Removes all databases from the current SharePoint farm into the availability group.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object