Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
254 lines (195 sloc) 7.57 KB
external help file applicable title schema author ms.author ms.reviewer
sharepointonline.xml
SharePoint Server 2013, SharePoint Server 2016
Set-SPODataConnectionSettingMetadata
2.0.0
trent-green
trgreen

Set-SPODataConnectionSettingMetadata

SYNOPSIS

Updates properties for the metadata of a Business Connectivity Services connection.

SYNTAX

Identity

Set-SPODataConnectionSettingMetadata [-Identity] <ODataConnectionSettings>
 -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>]
 [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm] [-SecureStoreTargetApplicationId <String>]
 [-ServiceAddressMetadataURL <Uri>] [-WhatIf] [<CommonParameters>]

Name

Set-SPODataConnectionSettingMetadata -ServiceContext <SPServiceContextPipeBind> -Name <String>
 [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <ODataAuthenticationMode>] [-Confirm]
 [-SecureStoreTargetApplicationId <String>] [-ServiceAddressMetadataURL <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 (https://go.microsoft.com/fwlink/?LinkID=187810).

Use the Set-SPODataConnectionSettingMetaData cmdlet to update properties for a Business Connectivity Services connection for a Business Connectivity Services service application in the farm.

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-SPODataConnectionSettingMetadata -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough"

This example updates the authentication mode of the metadata of Business Connectivity Services connection named ContosoServiceApp.

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

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

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

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

PARAMETERS

-Identity

Specifies the OData Connection Settings object.

Type: ODataConnectionSettings
Parameter Sets: Identity
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ServiceContext

Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or an 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
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the existing Business Connectivity Services connection.

Type: String
Parameter Sets: Name
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AuthenticationMode

Specifies the type of authentication mode that the Business Connectivity Services connection requires.

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

--PassThrough --RevertToSelf --Credentials --WindowsCredentials --DigestCredentials --ClientCertificate --Anonymous

Type: ODataAuthenticationMode
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ServiceAddressMetadataURL

Specifies the metadata URL for the OData service. This URL does not have to be Internet facing. If a value is not specified for a connection, a default value is used.

Type: Uri
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Server 2013, SharePoint Server 2016

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-SPODataConnectionSettingMetaData

You can’t perform that action at this time.