Get-SPUser
指定された検索条件に一致するユーザー アカウント (複数可) を取得します。
構文
Default (既定)
Get-SPUser
[[-Identity] <SPUserPipeBind>]
-Web <SPWebPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Group <SPGroupPipeBind>]
[-Limit <String>]
[<CommonParameters>]
説明
Get-SPUser コマンドレットでは、Identity、Web、または Group パラメーターで指定された範囲に一致するすべての SharePoint ユーザー アカウントを取得します。
Identity パラメーターにユーザーのエイリアスを使用して完全一致を取得できます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
例 1
Get-SPUser -Web 'https://sharepoint.contoso.com' -Group 'Viewers'
次の使用例は、サイト https://sharepoint.contoso.com上の SharePoint グループ閲覧者のすべてのメンバーを返します。
例 2
Get-SPUser -Identity 'i:0#.w|contoso\jdoe' -Web 'https://sharepoint.contoso.com'
次の使用例は、サイト https://sharepoint.contoso.comの Windows 要求を介して識別された特定のユーザーを返します。
例 3
Get-SPUser -Identity 'contoso\jdoe' -Web 'https://sharepoint.contoso.com'
次の使用例は、サイト https://sharepoint.contoso.comのクラシック Windows 認証を介して識別された特定のユーザーを返します。
パラメーター
-AssignmentCollection
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Group
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
新しいユーザーが属するユーザー グループを指定します。
パラメーターのプロパティ
| 型: | SPGroupPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
返されるユーザーの ID またはログイン名を指定します。
種類は、従来の Windows 認証の "CONTOSO\jdoe" の形式や 'i:0#.w| など、有効な ID またはログイン名である必要があります。Contoso\jdoe' for Windows Claims。
パラメーターのプロパティ
| 型: | SPUserPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | UserAlias |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Limit
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
取得するユーザーの最大数を指定します。 既定値は 500 です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Web
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
範囲として使用する Web サイトを指定します。
型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID である必要があります。SharePoint Foundation Web サイトの有効な名前 (MySPSite1 など)。または有効な SPWeb オブジェクトのインスタンス。
パラメーターのプロパティ
| 型: | SPWebPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。