SharePoint 2010 管理シェルを使用してサービス アプリケーションを管理する

最終更新日: 2015年3月9日

適用対象: SharePoint Foundation 2010

この記事の内容
SharePoint スナップインを Windows PowerShell に追加する
Windows PowerShell コマンドを使用してサービス アプリケーションを管理する
コマンドレットを作成するためのベスト プラクティス

SharePoint Foundation 2010 の SharePoint 管理シェルには、SharePoint 2010 の開発、展開、および管理を簡単かつ効率的に行うための Windows PowerShell コマンドレットが多数用意されています。

SharePoint 管理シェルは、Stsadm.exe 管理ツールに代わるものとなります。Microsoft SharePoint Foundation 2010 でのコマンドライン ツールや管理ファイルの現在および今後のすべての開発では、この新しいスクリプト テクノロジを使用することをお勧めします。

注意

共有サービス プロバイダー (SSP) の作成、列挙、および管理で使用される Stsadm コマンドは Service Application Framework では使用できません。

SharePoint スナップインを Windows PowerShell に追加する

SharePoint Foundation 2010 コマンドレットを Windows PowerShell コマンド ウィンドウ内から使用するには、SharePoint 2010 スナップインを Windows PowerShell に追加します。

SharePoint スナップインを Windows PowerShell に追加するには

  1. Windows PowerShell を開きます。

  2. Windows PowerShell ウィンドウで、「get-PSSnapin – Registered」と入力します。SharePoint Foundation 2010 スナップインが表示されます。

  3. Windows PowerShell ウィンドウで、「Add-PSSnapin Microsoft.SharePoint.Powershell」と入力します。

Windows PowerShell スナップインを Windows PowerShell$profile に永続的に追加することもできます。

Windows PowerShell コマンドを使用してサービス アプリケーションを管理する

Service Application Framework アプリケーションの開発者がサービス、サービス インスタンス、およびサービス アプリケーションを管理するときによく使用する Windows PowerShell の名詞と動詞を次の表に示します。

表 1. Service Application Framework で使用する Windows PowerShell の名詞と動詞

名詞

Windows PowerShell コマンド

SPService

  • Install-SPService

SPServiceInstance

  • Get-SPServiceInstance

  • Start-SPServiceInstance

  • Stop-SPServiceInstance

SPServiceApplication

  • Get-SPServiceApplication

  • Publish-SPServiceApplication

  • Remove-SPServiceApplication

  • Set-SPServiceApplication

  • Unpublish-SPServiceApplication

SPServiceApplicationProxy

  • Get-SPServiceApplicationProxy

  • Remove-SPServiceApplicationProxy

SPIisWebServiceApplicationPool

  • Get-SPServiceApplicationPool

  • New-SPServiceApplicationPool

  • Remove-SPServiceApplicationPool

  • Set-SPServiceApplicationPool

これらのコマンドレットのドキュメントは、SharePoint 管理シェルに用意されています。

コマンドレットを作成するためのベスト プラクティス

サービスを開発する場合、SharePoint 2010 固有の Windows PowerShell の動詞をオーバーライドして、独自のパラメーターを追加できます。ただし、これらのカスタム パラメーターは、SharePoint 2010 と同じ標準に準拠する必要があります。コマンドレットを作成または変更するときの推奨ベスト プラクティスを次に示します。

  • 派生元を既存の オブジェクトとする場合は、名詞の SP プレフィックスをサービスまたは機能の名前に置き換えます。

  • 派生元を既存の SharePoint 2010 オブジェクトとする場合は、共通の操作すべてに対して基本オブジェクトのメソッドを呼び出します。

  • 可能な場合には常に、既存のパラメーター名を再利用します。

関連項目

概念

SharePoint 管理シェルのコマンドレットの概要

SharePoint 管理シェルにおける Windows PowerShell