Set-SPODataConnectionSetting

  • [アーティクル]

 

**適用先:**SharePoint Server 2016

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

構文

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 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

このコマンドレットには、複数のパラメーター セットが含まれています。使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。パラメーター セットの使用法に関する詳しい情報については、「コマンドレット パラメーター セット」を参照してください。

Use the Set-SPODataConnectionSetting cmdlet to update the properties of an existing connection for a specific Business Connectivity Services service application.

注意

このコマンドレットは、社内環境のみに適用されます。SharePoint Online 管理シェルではこのコマンドを使用することはできません。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「Windows PowerShell for SharePoint Server 2016 リファレンス」のオンライン ドキュメントをご覧ください。

パラメーター

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

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。メモリの解放が必要になった場合は、 SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。割り当てコレクションまたは Global パラメーターが使用されていない場合、 SPWeb 、 SPSite 、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

注意

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

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

コマンドを実行する前に、確認のメッセージを表示します。詳細を表示するには、「 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

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。詳細を表示するには、「 get-help about_commonparameters 」と入力します。

Input Types

Return Types

関連項目

Get-SPODataConnectionSetting
New-SPODataConnectionSetting
Remove-SPODataConnectionSetting