Set-SPODataConnectionSetting

  • Article

 

Applies to: SharePoint Server 2016

Sets or updates global properties for a Microsoft Business Connectivity Services connection.

Syntax

Set-SPODataConnectionSetting -Name <String> <COMMON PARAMETERS>

Set-SPODataConnectionSetting -Identity <ODataConnectionSettings> <COMMON PARAMETERS>

COMMON PARAMETERS: -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <PassThrough | RevertToSelf | Credentials | WindowsCredentials | DigestCredentials | ClientCertificate | Anonymous>] [-Confirm [<SwitchParameter>]] [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [-ServiceAddressURL <Uri>] [-WhatIf [<SwitchParameter>]]

Example

-------------EXAMPLE 1-----------

Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough" -ExtensionProvider "Contoso.ExtensionProvider.Server, Contoso.ExtensionProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31ba4812ca364d35"

This example updates the properties of Business Connectivity Services connection named ContosoServiceApp.

-------------EXAMPLE 2-----------

$ConnectionVariable = Get-SPODataConnectionSetting -ServiceContext http://contoso -Name "ContosoServiceApp"

Set-SPODataConnectionSetting -Identity $ConnectionVariable -AuthenticationMode "PassThrough"

This example updates the properties of the Business Connectivity Services service connection named ContosoServiceApp.

-------------EXAMPLE 3-----------

Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough" -ExtensionProvider ""

This example updates the properties of Business Connectivity Services connection named ContosoServiceApp, the authentication mode has been changed, and extension provider value has been cleared.

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-SPODataConnectionSetting cmdlet to update the properties of an existing connection for a specific Business Connectivity Services service application.

Note

This cmdlet applies to an on-premises environment only. You cannot use this command in the SharePoint Online Management Shell.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016 reference.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.BusinessData.SystemSpecific.OData.ODataConnectionSettings

Specifies the OData Connection Settings object.

Name

Required

System.String

Specifies the name of the existing Business Connectivity Services connection.

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.

Note

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.

AuthenticationMode

Optional

Microsoft.SharePoint.BusinessData.SystemSpecific.OData.ODataAuthenticationMode

Specifies the type of authentication mode that is required for the Business Connectivity Services connection.

The value for the authentication mode is any one of the following options:

--PassThrough

--RevertToSelf

--Credentials

--WindowsCredentials

--DigestCredentials

--ClientCertificate

--Anonymous

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

ExtensionProvider

Optional

System.String

Extends the functionality provided by the OData connector in Business Connectivity Service as well as provides the fully qualified assembly name of an OData extension provider. Fully qualified assembly name should contain following parameters in this order:

Namespace.Class, Assembly Name, Version, Culture and Public Key. E.g. “Contoso.ExtensionProvider.Server, Contoso.ExtensionPRovider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31ba4812ca364d35”. To clear the value of ExtensionProvider, provide an empty string for example, “”.

SecureStoreTargetApplicationId

Optional

System.String

Specifies the Secure Store Target Application ID. Works in conjunction with the AuthenticationMode parameter.

The value for the SecureStoreTargetApplicationId parameter is any one of the following options:

--Credentials

--WindowsCredentials

--DigestCredentials

--ClientCertificate

ServiceAddressURL

Optional

System.Uri

Specifies the URL for the OData service. The URL does not have to be Internet facing. This is the final destination from which data is retrieved.

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

Input Types

Return Types

See also

Get-SPODataConnectionSetting
New-SPODataConnectionSetting
Remove-SPODataConnectionSetting