Set-UserPhoto

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

ユーザーが画像をアカウントに関連付けることができるユーザーの写真機能を構成するには、Set-UserPhoto コマンドレットを使用します。 Outlook、Microsoft Teams、SharePoint などのクライアント アプリケーションにユーザーの写真が表示されます。

注: Microsoft 365 では、Microsoft Graph PowerShell でユーザーの写真を管理できます。 手順については、「 Microsoft Graph PowerShell でのユーザーの写真の管理」を参照してください。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

CancelPhoto

Set-UserPhoto
    [-Identity] <MailboxIdParameter>
    [-Cancel]
    [-Confirm]
    [-GroupMailbox]
    [-DomainController <Fqdn>]
    [-IgnoreDefaultScope]
    [-PhotoType <String>]
    [-UseCustomRouting]
    [-WhatIf]
    [<CommonParameters>]

UploadPhotoData

Set-UserPhoto
    [-Identity] <MailboxIdParameter>
    -PictureData <Byte[]>
    [-Confirm]
    [-DomainController <Fqdn>]
    [-GroupMailbox]
    [-IgnoreDefaultScope]
    [-PhotoType <String>]
    [-UseCustomRouting]
    [-WhatIf]
    [<CommonParameters>]

UploadPreview

Set-UserPhoto
    [-Identity] <MailboxIdParameter>
    [-PictureData <Byte[]>]
    [-PictureStream <Stream>]
    [-Preview]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-GroupMailbox]
    [-IgnoreDefaultScope]
    [-PhotoType <String>]
    [-UseCustomRouting]
    [-WhatIf]
    [<CommonParameters>]

UploadPhotoStream

Set-UserPhoto
    [-Identity] <MailboxIdParameter>
    -PictureStream <Stream>
    [-Confirm]
    [-DomainController <Fqdn>]
    [-GroupMailbox]
    [-IgnoreDefaultScope]
    [-PhotoType <String>]
    [-UseCustomRouting]
    [-WhatIf]
    [<CommonParameters>]

SavePhoto

Set-UserPhoto
    [-Identity] <MailboxIdParameter>
    [-Save]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-GroupMailbox]
    [-IgnoreDefaultScope]
    [-PhotoType <String>]
    [-UseCustomRouting]
    [-WhatIf]
    [<CommonParameters>]

説明

ユーザーの写真機能を使用すると、ユーザーは画像を自分のアカウントに関連付けることができます。 ユーザーの写真は、ユーザーの Active Directory アカウントと、ユーザーの Exchange メールボックスのルート ディレクトリに保存されます。 管理者は、Set-UserPhoto コマンドレットを使用してユーザーの写真を構成します。 ユーザーは、Outlook on the web の [オプション] ページでユーザーの写真を自分のアカウントにアップロード、プレビュー、および保存できます。 ユーザーが写真をアップロードすると、Outlook on the web の [オプション] ページに写真のプレビューが表示されます。 これはプレビュー状態であり、Preview パラメーターを使用して Set-UserPhoto コマンドレットを実行した場合と同じ結果が作成されます。 ユーザーが [保存] をクリックすると、プレビューの写真がユーザーの写真として保存されます。 これは、 Set-UserPhoto -Save コマンドを実行した場合、または Set-UserPhoto -Preview コマンドと Set-UserPhoto -Save コマンドの両方を実行した場合と同じ結果です。 ユーザーが Outlook on the web の [オプション] ページでプレビュー写真をキャンセルすると、Set-UserPhoto -Cancel コマンドが呼び出されます。

Get-UserPhoto コマンドレットを実行してユーザーの写真に関する情報を表示するには、ユーザーにユーザーの写真を設定する必要があります。 そうしないと、指定したユーザーのユーザー写真が存在しないことを示すエラー メッセージが表示されます。 または、 Get-UserPhoto -Preview コマンドを実行して、プレビュー写真に関する情報を表示することもできます。

注: 影響を受けるユーザーがプロファイル ページ (個人用サイト) または大きなサムネイル画像を表示する SharePoint ページにアクセスするまで、ユーザーの写真への変更は SharePoint に表示されません。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 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

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

[キャンセル] スイッチを押すと、現在のプレビュー写真が削除されます。 このスイッチで値を指定する必要はありません。

ユーザーのアカウントに現在関連付けられている写真を削除するには、Remove-UserPhoto コマンドレットを使用します。 Cancel スイッチはプレビュー写真のみを削除します。

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

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

パラメーター セット

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

-Confirm

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットに与える影響は、コマンドレットが続行する前に確認を必要とするかどうかによって異なります。

  • データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値を指定せずに Confirm スイッチを指定すると、一時停止が発生し、続行する前にコマンドの確認を強制されます。

このコマンドレットには一時停止が組み込まれているため、 -Confirm:$false を使用して確認をスキップします。

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

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

パラメーター セット

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

-DomainController

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。

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

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

パラメーター セット

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

-GroupMailbox

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE

GroupMailbox スイッチは、Microsoft 365 グループを変更するために必要です。 このスイッチで値を指定する必要はありません。

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

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

パラメーター セット

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

-Identity

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Identity パラメーターは、ユーザーの ID を指定します。 ユーザーを一意に識別する任意の値を使用できます。 以下に例を示します。

  • 名前
  • Alias
  • 識別名 (DN)
  • 正規 DN
  • ドメイン\ユーザー名
  • 電子メール アドレス
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ユーザー ID またはユーザー プリンシパル名 (UPN)

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

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

パラメーター セット

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

-IgnoreDefaultScope

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

IgnoreDefaultScope スイッチは、Exchange PowerShell セッションに対する受信者の範囲の既定の設定を無視し、フォレスト全体を範囲として使用するようにコマンドに指示します。 このスイッチで値を指定する必要はありません。

このスイッチを使用すると、コマンドは、既定の範囲では現在使用できない Active Directory オブジェクトにアクセスできますが、次の制限もあります。

  • DomainController パラメーターは使用できません。 このコマンドは、適切なグローバル カタログ サーバーを自動的に使用します。
  • Identity パラメーターの DN しか使用できません。 エイリアスや GUID などの他の形式の ID は使用できません。

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

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

パラメーター セット

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

-PhotoType

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE

このパラメーターは、Microsoft の内部使用のために予約されています。

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

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

パラメーター セット

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

-PictureData

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

PictureData パラメーターは、ユーザーのアカウントにアップロードする写真ファイルを指定します。

このパラメーターの有効な値を指定するには、次の構文を使用してファイルをバイト エンコード オブジェクトに読み取る必要があります。 ([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))。 このコマンドはパラメーター値として使用することも、出力を変数 ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')) に書き込み、変数をパラメーター値 ($data) として使用することもできます。

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

型:

Byte[]

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

パラメーター セット

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

-PictureStream

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

PictureStream パラメーターは、ユーザーのアカウントにアップロードする写真を指定します。 このパラメーターは、ユーザーが写真を追加するときに、Outlook on the web などのクライアント アプリケーションによって使用されます。 PowerShell を使用して写真をアップロードするには、PictureData パラメーターを使用して写真ファイルを指定します。

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

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

パラメーター セット

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

-Preview

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Preview スイッチは、ユーザー アカウント用にプレビュー写真をアップロードします。 このスイッチで値を指定する必要はありません。

プレビューの写真はユーザーのアカウントにアップロードされますが、保存されません。 たとえば、ユーザーが Outlook on the web に写真をアップロードした場合 保存する前にプレビューするオプション。 プレビュー スイッチを使用してプレビュー写真をアップロードする場合は、コマンド Set-UserPhoto -Save を実行してユーザーの写真として保存する必要があります。

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

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

パラメーター セット

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

-Save

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

[保存] スイッチは、アップロードされた写真をユーザーの写真として保存することを指定します。 このスイッチで値を指定する必要はありません。

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

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

パラメーター セット

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

-WhatIf

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

[WhatIf] スイッチは、何も変更を加えずにコマンドが実行する内容を表示します。 このスイッチで値を指定する必要はありません。

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

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

パラメーター セット

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

CommonParameters

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

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。