Set-SPUser
既存のユーザーのプロパティを構成します。
構文
Set-SPUser
[-Identity] <SPUserPipeBind>
[-AddPermissionLevel <String[]>]
[-AssignmentCollection <SPAssignmentCollection>]
[-ClearPermissions]
[-Confirm]
[-DisplayName <String>]
[-Email <String>]
[-Group <SPGroupPipeBind>]
[-IsSiteCollectionAdmin]
[-PassThru]
[-RemovePermissionLevel <String[]>]
[-SyncFromAD]
[-Web <SPWebPipeBind>]
[-WhatIf]
[<CommonParameters>]
説明
Set-SPUser
コマンドレットは、既存のユーザーのプロパティを構成します。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
------------------ 例 1 -----------------------
Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -AddPermissionLevel "Contributor"
次の使用例は、ユーザー (Contoso\jdoe) を https://intranet.contoso.com
の共同作成者に設定します。
------------------ 例 2 -----------------------
Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -SyncFromAD
これにより、ユーザー 'contoso\jdoe' のユーザー情報リストが現在の displayName
で更新され、ユーザーの Active Directory アカウントの属性値が mail
されます。
パラメーター
-AddPermissionLevel
ユーザーに追加する権限レベルを指定します。
この値は、次のいずれかであることが必要です。
--貢献する
リスト アイテムとドキュメントを表示、追加、更新、削除できます。
--設計
ドキュメントを表示、追加、更新、削除、承認、カスタマイズできます。
--Full Control
すべてのドキュメントを完全に制御できます。
--Limited Access
アクセス許可が付与されている場合は、特定のリスト、ドキュメント ライブラリ、リスト アイテム、フォルダー、またはドキュメントを表示できます。
--読む
ページとリスト アイテムを表示し、ドキュメントをダウンロードできます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-AssignmentCollection
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment
コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
型: | SPAssignmentCollection |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-ClearPermissions
ユーザーに割り当てられたすべての権限を削除します。 [クリア] と [値の追加] が存在する場合は、最初にアクセス許可がクリアされ、新しいアクセス許可が追加されます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-DisplayName
ユーザーの新しい表示名を指定します。
この型は、有効な名前であることが必要です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
ユーザーの新しい電子メール アドレスを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-Group
指定したサイトの既存のグループにユーザーを追加します。
型: | SPGroupPipeBind |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-Identity
返されるユーザーの GUID、ログイン名、または SPUser オブジェクトを指定します。
型は、フォーム 1234-5678-9876-0987 の既存のユーザーの GUID である必要があります。
型: | SPUserPipeBind |
Aliases: | UserAlias |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-IsSiteCollectionAdmin
ユーザーをサイト コレクション管理者として設定するかどうかを指定します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-PassThru
指定しない場合、このコマンドレットが何も出力しないことを示します。 このパラメーターを指定すると、このユーザーの SPUser オブジェクトが返されます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-RemovePermissionLevel
ユーザーから権限レベルを削除します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-SyncFromAD
指定した場合、ユーザー情報がユーザー ディレクトリ ストアと同期されます。 このスイッチは、ディレクトリ ストアから displayName
と mail
の値のみを取得します。 Active Directory (クラシックまたはWindows 認証)、Forms ベースの認証、SAML がサポートされます。 FBA プロバイダーと SAML プロバイダーは、この切り替えを機能させるには、ディレクトリ ストアからの解決をサポートする必要があります。 スイッチでは、SharePoint ユーザー オブジェクトのみがサポートされます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-Web
範囲として使用する URL の名前または GUID を指定します。 このパラメーターは、SPUser オブジェクトが ID として指定されている場合は必要ありません。
値は、フォーム 1234-5678-9807 の https://server_name形式の本物の URL または GUID である必要があります。
型: | SPWebPipeBind |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |
-WhatIf
コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
適用対象: | SharePoint Server Subscription Edition |