Remove-SPODataConnectionSetting

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

Business Connectivity Services 接続を削除します。

構文

Remove-SPODataConnectionSetting
      [-Identity] <ODataConnectionSettings>
      -ServiceContext <SPServiceContextPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-SPODataConnectionSetting
      -ServiceContext <SPServiceContextPipeBind>
      -Name <String>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

説明

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

Remove-SPODataConnectionSetting コマンドレットは、ファーム内の特定の Business Connectivity Services のサービス アプリケーションの Business Connectivity Services 接続を削除するために使用します。

Business Connectivity Services 接続に関連付けられているメタデータ オブジェクトも削除されます。

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

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

例

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

Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp"

この例では、ContosoServiceApp という名前の Business Connectivity Services 接続を削除します。 メタデータのプロパティも削除されます。

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

Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp-metadata"

この例では、ContosoServiceApp という名前の Business Connectivity Services 接続メタデータを削除します。

関連する Business Connectivity Services 接続オブジェクトも削除されます。

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

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

Remove-SPODataConnectionSetting -Identity $ConnectionVariable -ServiceContext "http://contoso"

この例では、Business Connectivity Services 接続と、ContosoServiceApp という名前の関連するメタデータ接続を削除します。

パラメーター

-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

-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

-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

-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