Set-SPODataConnectionSetting

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

説明

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.

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

This cmdlet applies to an on-premises environment only. You cannot use this command in the SharePoint Online Management Shell.

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

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

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

--Credentials --WindowsCredentials --DigestCredentials --ClientCertificate

Type:String
Position:Named
Default value:None
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
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
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016