Add-SPShellAdmin

指定したデータベースの SharePoint_Shell_Access ロールにユーザーを追加します。

構文

Add-SPShellAdmin
   [-UserName] <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-Database <SPDatabasePipeBind>]
   [-WhatIf]
   [<CommonParameters>]

説明

このコマンドレットを実行してユーザーを SharePoint_Shell_Access ロールに追加するときは、SQL Server インスタンスにある securityadmin 固定サーバー ロールのメンバーシップ、影響を受けるすべてのデータベース上にある db_owner 固定データベース ロールのメンバーシップ、さらにローカル コンピューター上のローカルな管理者権限が必要です。

このコマンドレットは、Windows 認証を使用するデータベースでのみ使用することを目的としています。SQL 認証を使用するデータベースでこのコマンドレットを使用する必要はありません。実際使用すると、エラー メッセージが発生することがあります。

次のように、Add-SPShellAdmin コマンドレットを使用して SharePoint_Shell_Access ロールにユーザーを追加します。

-- ユーザーのみを指定すると、ユーザーはファーム構成データベース用のロールに追加されます。

-- database パラメーターを使用すると、ユーザーは、ファーム構成データベース、サーバーの全体管理コンテンツ データベース、および指定したデータベース上のロールに追加されます。ほとんどの管理操作ではサーバーの全体管理コンテンツ データベースへのアクセスが必要になるため、database パラメーターを使用することをお勧めします。

SharePoint_Shell_Access ロールに追加されたユーザーは、すべての Web サーバーの WSS_Admin_WPG グループに追加されます。対象のデータベースに SharePoint_Shell_Access ロールがない場合は、自動的に作成されます。

SharePoint 製品に Windows PowerShell を使用するには、構成データベースの SharePoint_Shell_Access ロールのメンバーであり、SharePoint 製品がインストールされているコンピューター上の WSS_ADMIN_WPG ローカル グループのメンバーである必要があります。

ただし、このコマンドレットを実行した結果、UserName パラメーターで指定されたユーザーは、SPDataAccess ロールが存在する場合は SPDataAccess ロール、または SPDataAccess ロールが存在しない場合は db_owner ロールを、上記のように影響を受けるデータベースに対して持つという結果になります。 したがって、このアクセスを与えるユーザーを慎重に選ぶ必要があります。

したがって、このアクセスを与えるユーザーを慎重に選ぶ必要があります。

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

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

Add-SPShellAdmin -UserName CONTOSO\User1

この例では、User1 という名前の新しいユーザーをファーム構成データベースのみの SharePoint_Shell_Access ロールに追加します。このユーザーは、ファームの各サーバーの WSS_Admin_WPG ローカル グループにも追加されます。

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

Add-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6

この例では、User1 という名前の新しいユーザーを、データベースの GUID をコマンドレットに渡すことによって、指定されたコンテンツ データベースと構成データベースの両方の SharePoint_Shell_Access ロールに追加します。

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

Get-SPDatabase | Where-Object {$_.WebApplication -like "SPAdministrationWebApplication"} | Add-SPShellAdmin CONTOSO\User1

この例では、User1 という名前の新しいユーザーを、指定されたサーバーの全体管理コンテンツ データベースと構成データベースの両方の SharePoint_Shell_Access ロールに追加します。

------------------- 例 4 -------------------------

Get-SPDatabase | ?{$_.Name -eq "WSS_Content"} | Add-SPShellAdmin -Username CONTOSO\User1

この例では、User1 という名前の新しいユーザーを、データベースの名前をコマンドレットに渡すことによって、指定されたコンテンツ データベースと構成データベースの両方の SharePoint_Shell_Access ロールに追加します。

パラメーター

-AssignmentCollection

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

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

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition
-Confirm

コマンドを実行する前に、確認のメッセージを表示します。詳細を表示するには、「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 Subscription Edition
-Database

ユーザーを追加する SharePoint_Shell_Access ロールを含むデータベースまたは Database オブジェクトの GUID を指定します。 database パラメーターを指定しない場合は、構成データベースが使用されます。別のデータベースを指定した場合でも、ファーム構成データベースは常に含まれます。

Type:SPDatabasePipeBind
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition
-UserName

対象データベースの SharePoint_Shell_Access ロールに追加するユーザーの名前を指定します。

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition
-WhatIf

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