Set-SPUser

モジュール:
SharePointServer module

既存のユーザーのプロパティを構成します。

構文

Default (既定) 

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' のユーザー情報リストが、ユーザーの Active Directory アカウントの現在の displayName と mail 属性値で更新されます。

パラメーター

-AddPermissionLevel

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーに追加する権限レベルを指定します。

この値は、次のいずれかであることが必要です。

--投稿

リスト アイテムとドキュメントを表示、追加、更新、削除できます。

--デザイン

ドキュメントの表示、追加、更新、削除、承認、カスタマイズを行うことができます。

--フルコントロール

すべてのドキュメントをフル コントロールできます。

--制限付きアクセス

アクセス許可が付与されている場合、特定のリスト、ドキュメント ライブラリ、リスト アイテム、フォルダー、またはドキュメントを表示できます。

--Read

ページ、リスト アイテムを表示したり、ドキュメントをダウンロードしたりできます。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-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

-ClearPermissions

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーに割り当てられたすべての権限を削除します。 [クリア] と [値の追加] が存在する場合は、まずアクセス許可がクリアされてから、新しいアクセス許可が追加されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DisplayName

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーの新しい表示名を指定します。

この型は、有効な名前であることが必要です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Email

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーの新しい電子メール アドレスを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値: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

返されるユーザーの GUID、ログイン名、または SPUser オブジェクトを指定します。

種類は、1234-5678-9876-0987 の形式の既存のユーザーの GUID である必要があります。

パラメーターのプロパティ

型:SPUserPipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:UserAlias

パラメーター セット

(All)
配置:1
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-IsSiteCollectionAdmin

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーをサイト コレクション管理者として設定するかどうかを指定します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PassThru

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

指定しない場合、このコマンドレットが何も出力しないことを示します。 このパラメーターを指定すると、このユーザーの SPUser オブジェクトが返されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RemovePermissionLevel

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

ユーザーから権限レベルを削除します。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SyncFromAD

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

指定した場合、ユーザー情報がユーザー ディレクトリ ストアと同期されます。 このスイッチは、ディレクトリ ストアから displayName と mail の値のみを取得します。 Active Directory (クラシックまたは Windows 認証)、フォーム ベース認証、SAML をサポートします。 FBAおよびSAMLプロバイダーが、このスイッチを機能させるには、ディレクトリストアからの解決をサポートする必要があります。 このスイッチは SharePoint ユーザー オブジェクトのみをサポートします。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Web

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

範囲として使用する URL の名前または GUID を指定します。 このパラメーターは、SPUser オブジェクトが ID として指定されている場合は必要ありません。

値は、 https://server_name 形式の本物の URL、または 1234-5678-9807 の形式の GUID である必要があります。

パラメーターのプロパティ

型:SPWebPipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。