Remove-DatabaseFromAvailabilityGroup
Removes one or more SharePoint databases from an availability group in SQL Server.
Syntax
Default
Remove-DatabaseFromAvailabilityGroup
[-AGName] <String>
-DatabaseName <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-Force]
[-KeepSecondaryData]
[<CommonParameters>]
AllDatabases
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
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
The name of the availability group from which the databases are being removed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Default
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Forces a remove from the group.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-KeepSecondaryData
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies that copies of the databases on the replicas in the availability group will not be deleted. Otherwise, those database copies will be dropped.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProcessAllDatabases
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Removes all databases from the current SharePoint farm into the availability group.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AllDatabases
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.