.png)
Remove-SPODataConnectionSetting
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Removes a Business Connectivity Services connection.
Remove-SPODataConnectionSetting -Name <String> -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Remove-SPODataConnectionSetting [-Identity] <ODataConnectionSettings> -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| ServiceContext | Required | Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind | Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. | ||
| Name | Required | System.String | Specifies the name of the existing Business Connectivity Services connection. | ||
| 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 | ||
| 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 | ||
| Identity | Required | Microsoft.SharePoint.BusinessData.SystemSpecific.OData.ODataConnectionSettings | Specifies the OData Connection Settings object. | ||
| ServiceContext | Required | Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind | Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. | ||
| 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 | ||
| 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 Remove-SPODataConnectionSetting cmdlet to remove a Business Connectivity Services connection for a particular Business Connectivity Services service application in the farm.
The metadata object associated with the Business Connectivity Services connection is also deleted.
 Note: |
|---|
| This cmdlet applies to an on-premises environment only. You cannot use this command in the SharePoint Online Management Shell. |
Input Types
Return Types
----------------EXAMPLE 1------------
Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp"
This example removes the Business Connectivity Services connection named ContosoServiceApp. Metadata properties are also removed.
----------------EXAMPLE 2------------
Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp-metadata"
This example removes the Business Connectivity Services connection metadata named ContosoServiceApp.
The associated Business Connectivity Services connection object is also removed.
----------------EXAMPLE 3------------
$ConnectionVariable = Get-SPODataConnectionSettingMetadata -ServiceContext http://contoso -Name "ContosoServiceApp"
Remove-SPODataConnectionSetting –Identity $ConnectionVariable -ServiceContext "http://contoso"
This example removes the Business Connectivity Services and its associated metadata connection named ContosoServiceApp.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
