Set-SPAccessServicesDatabaseServerGroupMapping
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Sets server group mappings.
Set-SPAccessServicesDatabaseServerGroupMapping [-ServiceContext] <SPServiceContextPipeBind> -DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-CorporateCatalog <SwitchParameter>] [-DeveloperSite <SwitchParameter>] [-ObjectModel <SwitchParameter>] [-RemoteObjectModel <SwitchParameter>] [-StoreFront <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-SPAccessServicesDatabaseServerGroupMapping [-ServiceContext] <SPServiceContextPipeBind> -ClearMapping <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-CorporateCatalog <SwitchParameter>] [-DeveloperSite <SwitchParameter>] [-ObjectModel <SwitchParameter>] [-RemoteObjectModel <SwitchParameter>] [-StoreFront <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| ServiceContext | Required | Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind | Specifies the service context to set. | ||
| DatabaseServerGroup | Required | Microsoft.Office.Access.Services.PowerShell.AccessServicesDatabaseServerGroupPipeBind | Specifies the database server group mapping to set. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| CorporateCatalog | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the App Catalog. | ||
| DeveloperSite | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the developer site. | ||
| ObjectModel | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the Object model. | ||
| RemoteObjectModel | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the client side object model. | ||
| StoreFront | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the SharePoint Store. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | 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 |
| Parameter | Required | Type | Description | ||
| ServiceContext | Required | Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind | Specifies the service context to set. | ||
| ClearMapping | Required | System.Management.Automation.SwitchParameter | Removes any existing mappings between the source of the creation and the DatabaseServerGroup. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| CorporateCatalog | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the App Catalog. | ||
| DeveloperSite | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the developer site. | ||
| ObjectModel | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the Object model. | ||
| RemoteObjectModel | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the client side object model. | ||
| StoreFront | Optional | System.Management.Automation.SwitchParameter | Specifies Apps that are created from the SharePoint Store. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | 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 |
Detailed 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 Cmdlet Parameter Sets.
Use the Set-SPAccessServicesDatabaseServerGroupMapping cmdlet to set the mapping between the source of the request to create the application and the DatabaseServerGroup containing the server that is selected to create new databases on. Specify one or more of the sources to map them to the DatabaseServerGroup.
Input Types
Return Types
------------EXAMPLE----------
$context = [Microsoft.SharePoint.SPServiceContext]::GetContext($app.ServiceApplicationProxyGroup, [Microsoft.SharePoint.SPSiteSubscriptionIdentifier]::Default)
$dsg = Get-SPAccessServicesDatabaseServerGroup -ServiceContext $context
Set-SPAccessServicesDatabaseServerGroupMapping -ServiceContext $context -DatabaseServerGroup $dsg
This example sets a Access Services database server group mapping by using the $context and $dsg variables.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: