Update-Recipient

モジュール:
Exchange PowerShell

このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。

Update-Recipient コマンドレットを使用して、Exchange 属性を受信者オブジェクトに追加します。

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

構文

Default (既定) 

Update-Recipient
    [-Identity] <RecipientIdParameter>
    [-Confirm]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-WhatIf]
    [<CommonParameters>]

説明

オンプレミスの Exchange では、Update-Recipient コマンドレットを実行して Active Directory ユーザー オブジェクトを Exchange メールボックスに変換する前に、次の 3 つの必須 Exchange 属性を持つユーザー オブジェクトにスタンプを付ける必要があります。

  • homeMDB
  • mailNickname
  • msExchHomeServerName

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Update-Recipient -Identity "John Smith"

次の使用例は、John Smith のメールボックスを表すメール連絡先に Exchange 属性を追加します。

例 2

Get-MailContact -OrganizationalUnit "contoso.com/fabrikam.com Users" | Update-Recipient

オンプレミスの Exchange では、この例では、特定の組織単位 (OU) 内のすべての連絡先を更新します。 この例は、contoso.com と fabrikam.com の 2 つのフォレストで受信者が同期していること、そして fabrikam.com ドメイン内の同期している受信者はすべて、contoso.com ドメインにある fabrikam.com Users という特定の OU に格納されていることを前提としています。

パラメーター

-Confirm

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

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

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

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

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

パラメーター セット

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

-Credential

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

Credential パラメーターは、Active Directory へのアクセスに使用するユーザー名とパスワードを指定します。

このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential) に保存し、このパラメーターに変数名 ($cred) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。

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

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

パラメーター セット

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

-DomainController

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

パラメーターは、オンプレミスの Exchange でのみ使用できます。

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

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

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

パラメーター セット

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

-Identity

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

Identity パラメーターは、更新する受信者を指定します。 受信者を一意に識別する任意の値を使用できます。 たとえば、次の値を使用できます。

  • 名前
  • Alias
  • 識別名 (DN)
  • 正規 DN
  • 電子メール アドレス
  • GUID

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

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

パラメーター セット

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

-WhatIf

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

WhatIf スイッチは、変更を加えずにコマンドの動作を示します。 このスイッチで値を指定する必要はありません。

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

型: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」を参照してください。

入力

Input types

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

出力

Output types

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