Set-SPODataConnectionSetting
Sets or updates global properties for a Microsoft Business Connectivity Services connection.
Syntax
Set-SPODataConnectionSetting
[-Identity] <ODataConnectionSettings>
-ServiceContext <SPServiceContextPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-AuthenticationMode <ODataAuthenticationMode>]
[-Confirm]
[-ExtensionProvider <String>]
[-SecureStoreTargetApplicationId <String>]
[-ServiceAddressURL <Uri>]
[-WhatIf]
[<CommonParameters>] Set-SPODataConnectionSetting
-ServiceContext <SPServiceContextPipeBind>
-Name <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-AuthenticationMode <ODataAuthenticationMode>]
[-Confirm]
[-ExtensionProvider <String>]
[-SecureStoreTargetApplicationId <String>]
[-ServiceAddressURL <Uri>]
[-WhatIf]
[<CommonParameters>] 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.
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 https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831).
Examples
-------------EXAMPLE 1-----------
Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough"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.
Parameters
-AssignmentCollection
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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-AuthenticationMode
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
| Type: | ODataAuthenticationMode |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-Confirm
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-ExtensionProvider
Specifies the ODataExtensionProvider for the Business Connectivity Services connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-Identity
Specifies the OData Connection Settings object.
| Type: | ODataConnectionSettings |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-Name
Specifies the name of the existing Business Connectivity Services connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-SecureStoreTargetApplicationId
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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-ServiceAddressURL
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.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-ServiceContext
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.
| Type: | SPServiceContextPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
-WhatIf
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 |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016 |
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for