Set-SPODataConnectionSetting

 

適用先:SharePoint Foundation 2013, SharePoint Server 2013 Enterprise

トピックの最終更新日:2015-03-09

Microsoft Business Connectivity Services 接続のためのグローバル プロパティを設定または更新します。

Set-SPODataConnectionSetting -Name <String> -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <Nullable>] [-Confirm [<SwitchParameter>]] [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [-ServiceAddressURL <Uri>] [-WhatIf [<SwitchParameter>]]
Set-SPODataConnectionSetting [-Identity] <ODataConnectionSettings> -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationMode <Nullable>] [-Confirm [<SwitchParameter>]] [-ExtensionProvider <String>] [-SecureStoreTargetApplicationId <String>] [-ServiceAddressURL <Uri>] [-WhatIf [<SwitchParameter>]]

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

Set-SPODataConnectionSetting コマンドレットを使用して、特定の Business Connectivity Services サービス アプリケーションに対する既存の接続のプロパティを更新します。

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

SharePoint 管理シェル

 

パラメーター 必須 説明

Identity

必須

Microsoft.SharePoint.BusinessData.SystemSpecific.OData.ODataConnectionSettings

OData 接続設定オブジェクトを指定します。

ServiceContext

必須

Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind

サービス コンテキストを SPServiceContext オブジェクトのインスタンス、SPSiteAdministration オブジェクトの識別子、SPSite オブジェクトのいずれかの形式で指定します。たとえば、サービス コンテキストの値には、ID フィールド内の識別子、文字列識別子、URI、GUID の文字列表現などがあります。

Name

必須

System.String

既存の Business Connectivity Services 接続の名前を指定します。

AssignmentCollection

省略可

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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

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

AuthenticationMode

省略可

System.Nullable

Business Connectivity Services 接続に必要な認証モードの種類を指定します。

認証モードの値には、以下のいずれかのオプションを指定します。

--PassThrough

--RevertToSelf

--Credentials

--WindowsCredentials

--DigestCredentials

--ClientCertificate

--Anonymous

Confirm

省略可

System.Management.Automation.SwitchParameter

コマンドを実行する前に、確認のメッセージを表示します。詳細を表示するには、「get-help about_commonparameters」と入力します。

ExtensionProvider

省略可

System.String

Business Connectivity Service で OData コネクタが提供する機能を拡張し、OData 拡張機能プロバイダーの完全修飾アセンブリ名を指定します。完全修飾アセンブリ名には次のパラメーターを次の順序で含める必要があります。

名前空間.クラス、アセンブリ名、バージョン、カルチャ、および公開キー。例、"Contoso.ExtensionProvider.Server, Contoso.ExtensionPRovider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31ba4812ca364d35"。ExtensionProvider の値をクリアするには、"" のように空の文字列を指定します。

SecureStoreTargetApplicationId

省略可

System.String

Secure Store のターゲット アプリケーション ID を指定します。AuthenticationMode パラメーターと連携して動作します。

SecureStoreTargetApplicationId パラメーターの値には、以下のいずれかのオプションを指定します。

--Credentials

--WindowsCredentials

--DigestCredentials

--ClientCertificate

ServiceAddressURL

省略可

System.Uri

OData サービスの URL を指定します。この URL はインターネット URL である必要はありません。最終のデータ読み出し先となります。

WhatIf

省略可

System.Management.Automation.SwitchParameter

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

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

この例では、ContosoServiceApp という名前の Business Connectivity Services 接続のプロパティを更新します。

------------- 例 2 -----------

$ConnectionVariable = Get-SPODataConnectionSetting -ServiceContext http://contoso -Name "ContosoServiceApp"
Set-SPODataConnectionSetting -Identity $ConnectionVariable -AuthenticationMode "PassThrough"

この例では、ContosoServiceApp という名前の Business Connectivity Services サービス接続のプロパティを更新します。

------------- 例 3 -----------

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

この例では、ContosoServiceApp という名前の Business Connectivity Services 接続のプロパティを更新して認証モードを変更し、拡張機能プロバイダーの値をクリアします。

表示: