Set-SPODataConnectionSetting

  • リファレンス
モジュール:
Microsoft.Online.SharePoint.PowerShell
適用対象:
SharePoint Server 2013, SharePoint Server 2016

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

構文

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

説明

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

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

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

Windows PowerShell for SharePoint 製品の権限の詳細と最新情報については、https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). にあるオンライン ドキュメントを参照してください。

例

------------- 例 1 -----------

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

この例では、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 接続のプロパティを更新して認証モードを変更し、拡張機能プロバイダーの値をクリアします。

パラメーター

-AssignmentCollection

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

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

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

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

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

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

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

Business Connectivity Services 接続の ODataExtensionProvider を指定します。

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

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

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

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

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

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

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

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

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

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

サービス コンテキストを SPServiceContext オブジェクトのインスタンス、 SPSiteAdministration オブジェクトの識別子、SPSite オブジェクトのいずれかの形式で指定します。たとえば、サービス コンテキストの値には、ID フィールド内の識別子、文字列識別子、URI、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

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。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