.png)
New-SPBusinessDataCatalogServiceApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a new Business Data Connectivity service application in the farm.
New-SPBusinessDataCatalogServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-Name <String>] [-PartitionMode <SwitchParameter>] [-Sharing <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the IIS application pool to use for the new Business Data Connectivity service application. | ||
| DatabaseName | Required | System.String | Specifies the name for the Business Data Connectivity database. | ||
| DatabaseServer | Required | System.String | Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SERVER\Database. | ||
| Name | Required | System.String | Specifies a display name for the new Business Data Connectivity service application. | ||
| 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 | ||
| DatabaseCredentials | Optional | System.Management.Automation.PSCredential | Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. | ||
| DatabasePassword | Optional | System.Security.SecureString | Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. The type must be a valid password. | ||
| DatabaseUsername | Optional | System.String | Specifies the user name to use for connecting to the database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. | ||
| FailoverDatabaseServer | Optional | System.String | Specifies the name of the host server for the failover database server. | ||
| PartitionMode | Required | System.Management.Automation.SwitchParameter | Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. | ||
| Sharing | Required | System.Management.Automation.SwitchParameter | Specifies that the Business Data Connectivity application is published and shared across the farm. | ||
| 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 |
Note: Detailed Description
The New-SPBusinessDataCatalogServiceApplication cmdlet creates a new Business Data Connectivity service application in the farm.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
| Exceptions | Description |
|---|---|
------------------EXAMPLE------------------
New-SPBusinessDataCatalogServiceApplication –ApplicationPool "SharePoint Web Services Default" –DatabaseName "ContosoBdcDB" –DatabaseServer "CONTOSO\SharePoint" –Name "ContosoServiceApp"
This example creates a Business Data Connectivity service application named ContosoServiceApp. In this process it uses the SharePoint Web Services Default application pool and creates a database named ContosoBdcDB.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
