Set-UserPhoto
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
ユーザーが画像をアカウントに関連付けることができるユーザーの写真機能を構成するには、Set-UserPhoto コマンドレットを使用します。 ユーザーの写真は、Outlook on the web、Lync、Skype for Business、SharePoint などのオンプレミスおよびクラウドベースのクライアント アプリケーションに表示されます。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-UserPhoto
[-Identity] <MailboxIdParameter>
[-Cancel]
[-Confirm]
[-GroupMailbox]
[-DomainController <Fqdn>]
[-IgnoreDefaultScope]
[-PhotoType <String>]
[-WhatIf]
[<CommonParameters>] Set-UserPhoto
[-Identity] <MailboxIdParameter>
-PictureData <Byte[]>
[-Confirm]
[-DomainController <Fqdn>]
[-GroupMailbox]
[-IgnoreDefaultScope]
[-PhotoType <String>]
[-WhatIf]
[<CommonParameters>] Set-UserPhoto
[-Identity] <MailboxIdParameter>
[-PictureData <Byte[]>]
[-PictureStream <Stream>]
[-Preview]
[-Confirm]
[-DomainController <Fqdn>]
[-GroupMailbox]
[-IgnoreDefaultScope]
[-PhotoType <String>]
[-WhatIf]
[<CommonParameters>] Set-UserPhoto
[-Identity] <MailboxIdParameter>
-PictureStream <Stream>
[-Confirm]
[-DomainController <Fqdn>]
[-GroupMailbox]
[-IgnoreDefaultScope]
[-PhotoType <String>]
[-WhatIf]
[<CommonParameters>] Set-UserPhoto
[-Identity] <MailboxIdParameter>
[-Save]
[-Confirm]
[-DomainController <Fqdn>]
[-GroupMailbox]
[-IgnoreDefaultScope]
[-PhotoType <String>]
[-WhatIf]
[<CommonParameters>] 説明
ユーザー写真機能を使用すると、ユーザーは自分のアカウントに画像を関連付けることができます。 ユーザーの写真は、ユーザーの Active Directory アカウントと、ユーザーの Exchange メールボックスのルート ディレクトリに格納されます。 管理者は、Set-UserPhoto コマンドレットを使用してユーザーの写真を構成します。 ユーザーは、Outlook on the webの [オプション] ページで、自分のアカウントにユーザー写真をアップロード、プレビュー、保存できます。 ユーザーが写真をアップロードすると、写真のプレビューがOutlook on the webの [オプション] ページに表示されます。 これはプレビュー状態であり、Preview パラメーターを使用して Set-UserPhoto コマンドレットを実行した場合と同じ結果が作成されます。 ユーザーが [保存] をクリックすると、プレビュー写真がユーザーの写真として保存されます。 これは、コマンドの実行または コマンドと コマンドの両方Set-UserPhoto -PreviewのSet-UserPhoto -Save実行とSet-UserPhoto -Save同じ結果です。 ユーザーがOutlook on the webの [オプション] ページでプレビュー写真を取り消すとSet-UserPhoto -Cancel、コマンドが呼び出されます。
ユーザーの写真に関する情報を表示するには、Get-UserPhoto コマンドレットを実行する前に、ユーザーの写真を設定する必要があります。 それ以外の場合は、指定したユーザーのユーザー写真が存在しないことを示すエラー メッセージが表示されます。 または、コマンドを Get-UserPhoto -Preview 実行してプレビュー写真に関する情報を表示することもできます。
注:
- 影響を受けるユーザーが自分のプロファイル ページ (個人用サイト) または大きなサムネイル画像を示す SharePoint ページにアクセスするまで、ユーザー写真に対する変更は SharePoint に表示されません。
- Microsoft Graph PowerShell では、 Update-MgUserPhoto コマンドレットと Set-MgUserPhotoContent コマンドレットも使用できます。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-UserPhoto -Identity "Paul Cannon" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\PaulCannon.jpg"))次の使用例では、1 つのコマンドで写真を Paul Cannon のユーザー アカウントにアップロードして保存します。
例 2
Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview
Set-UserPhoto "Ann Beebe" -Save次の使用例は、2 つのコマンドを使用して、プレビュー写真を Ann Beebe のユーザー アカウントにアップロードして保存する方法を示します。 最初のコマンドは、Ann Beebe のユーザー アカウントにプレビュー写真をアップロードし、2 番目のコマンドはアップロードした写真をプレビュー写真として保存します。
例 3
Set-UserPhoto -Identity "Ann Beebe" -Cancel次の使用例は、前の例でアップロードしたプレビュー写真を削除します。
パラメーター
-Cancel
Cancel switch パラメーターは、プレビュー写真として現在アップロードされている写真を削除します。 このスイッチで値を指定する必要はありません。
ユーザーのアカウントに現在関連付けられている写真を削除するには、Remove-UserPhoto コマンドレットを使用します。 Cancel スイッチはプレビュー写真のみを削除します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-GroupMailbox
Microsoft 365 グループを変更するには、GroupMailbox スイッチが必要です。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
Identity パラメーターは、ユーザーの ID を指定します。 ユーザーを一意に識別する任意の値を使用できます。 以下に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
| Type: | MailboxIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IgnoreDefaultScope
IgnoreDefaultScope スイッチは、Exchange PowerShell セッションに対する受信者の範囲の既定の設定を無視し、フォレスト全体を範囲として使用するようにコマンドに指示します。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、コマンドは、既定の範囲では現在使用できない Active Directory オブジェクトにアクセスできますが、次の制限もあります。
- DomainController パラメーターは使用できません。 このコマンドは、適切なグローバル カタログ サーバーを自動的に使用します。
- Identity パラメーターの DN しか使用できません。 エイリアスや GUID などの他の形式の ID は使用できません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PhotoType
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PictureData
PictureData パラメーターは、ユーザーのアカウントにアップロードされる写真ファイルを指定します。
このパラメーターの有効な値を使用するには、次の構文を使用して、ファイルをバイトエンコード されたオブジェクトに読み取る必要があります。 ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')) このコマンドをパラメーター値として使用することも、変数 () に出力を書き込み、変数をパラメーター値 ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')$data) として使用することもできます。
| Type: | Byte[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PictureStream
PictureStream パラメーターは、ユーザーのアカウントにアップロードされる写真を指定します。 このパラメーターは、ユーザーが写真を追加するときにOutlook on the webなどのクライアント アプリケーションで使用されます。 PowerShell を使用して写真をアップロードするには、PictureData パラメーターを使用して写真ファイルを指定します。
| Type: | Stream |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Preview
Preview スイッチは、ユーザー アカウント用にプレビュー写真をアップロードします。 このスイッチで値を指定する必要はありません。
プレビュー写真は、ユーザーのアカウントにアップロードされるが保存されない写真オブジェクトです。 たとえば、ユーザーがOutlook on the webオプションで写真をアップロードし、保存する前にプレビューする場合です。 プレビュー スイッチを使用してプレビュー写真をアップロードする場合は、コマンド Set-UserPhoto -Save を実行してユーザーの写真として保存する必要があります。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Save
Save スイッチは、ユーザーのアカウントにアップロードされた写真をユーザーの写真として保存するように指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。