| external help file | Microsoft.Office.Server.dll-help.xml |
|---|---|
| Module Name | SharePointServer |
| online version | https://learn.microsoft.com/powershell/module/microsoft.sharepoint.powershell/get-spserverscaleoutdatabase |
| applicable | SharePoint Server Subscription Edition |
| title | Get-SPServerScaleOutDatabase |
| schema | 2.0.0 |
Returns all scale-out database objects.
Get-SPServerScaleOutDatabase -ServiceApplication <SPServiceApplicationPipeBind>
[-AssignmentCollection <SPAssignmentCollection>] [-Confirm] [-WhatIf] [<CommonParameters>]
Use the Get-SPServerScaleOutDatabase cmdlet to return all scale-out database objects for the specified service application.
A scale-out database is a database which implements the Shared Service Database Scale Out Generic Protocol. For more information, see SharePoint Shared Service Database Scale Out Generic Protocol Specification (https://go.microsoft.com/fwlink/p/?LinkId=273867)
$serviceApplication = Get-SPServiceApplication -Name "AppManagement"
Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplicationThis example gets all scale-out databases for the given service application by using the $serviceApplication variable.
Applicable: SharePoint Server Subscription Edition
Specifies the service application of the scale-out databases.
Type: SPServiceApplicationPipeBind
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server Subscription Edition
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseApplicable: SharePoint Server Subscription Edition
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server Subscription Edition
Displays a message that describes the effect of the command instead of executing the command.
For more information, type the following command: get-help about_commonparameters
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).