Update-SiteMailbox
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Update-SiteMailbox コマンドレットを使用して、Microsoft SharePoint 同期をトリガーします。 このコマンドは、ドキュメント コンテンツのメンバーシップとアクセス許可を Microsoft Exchange に同期します。 ドキュメントまたはメンバーシップの同期に関する問題のトラブルシューティングを行うときに、このアクションを実行する必要がある場合があります。
サイト メールボックスは、2017 年に Exchange Online および SharePoint Online で非推奨になりました。 詳細については、「 サイト メールボックスの廃止」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Update-SiteMailbox
[-Identity] <RecipientIdParameter>
[-BypassOwnerCheck]
[-Confirm]
[-FullSync]
[-Organization <OrganizationIdParameter>]
[-Server <String>]
[-Target <TargetType>]
[-WhatIf]
[<CommonParameters>]
説明
自分が所有していないサイト メールボックスに対してこのコマンドを実行する場合は、BypassOwnerCheck パラメーターを指定してこのコマンドレットを実行する必要があります。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Update-SiteMailbox -BypassOwnerCheck -Identity "MarketingEvents 2013"
この例では、サイトのメールボックス MarketingEvents 2013 を更新します。 対象を指定しなかった場合は、ドキュメントとメンバーシップの両方の同期がトリガーされます。 BypassOwnerCheck パラメーターが使用されているため、このコマンドレットを実行するためにサイト メールボックスの所有者またはメンバーである必要はありません。
例 2
Update-SiteMailbox -BypassOwnerCheck -Identity WinterHoliday@tailspintoys.com -FullSync
次の使用例は、サイト メールボックス WinterHoliday@tailspintoys.com を更新し、完全同期を実行します。 既定では、最後の同期以降の更新分のみが同期されます。 これはドキュメントの同期のみに適用されます。
パラメーター
-BypassOwnerCheck
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
BypassOwnerCheck パラメーターは、コマンドを実行しているアカウントがサイト メールボックスのメンバーまたは所有者でない場合に使用されます。 このスイッチで値を指定する必要はありません。
このスイッチを使用せず、サイト メールボックスのメンバーまたは所有者でない場合、コマンドは失敗します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FullSync
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
FullSync スイッチは、完全同期を指定します。 このスイッチで値を指定する必要はありません。
完全同期はコストがかかり、Exchange システムのパフォーマンスに影響します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Identity パラメーターは、更新するサイト メールボックスを指定します。 サイト メールボックスを一意に識別する任意の値を使用できます。 例:
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
パラメーターのプロパティ
| 型: | RecipientIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Organization
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、Microsoft の内部使用のために予約されています。
パラメーターのプロパティ
| 型: | OrganizationIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Server
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Server パラメーターは、サイト メールボックスが配置されている完全修飾ドメイン名 (FQDN) または Microsoft SharePoint サーバーを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Target
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Target パラメーターは、SharePoint ドキュメント、サイト メールボックスのメンバーシップ リスト、またはその両方を更新するかどうかを指定します。 このパラメーターは、IncludedRecipients パラメーターや、すべての Conditional パラメーターと併用できません。
- すべて
- ドキュメント
- メンバーシップ
コマンドレットの実行時にこのパラメーターを指定しないと、このパラメーターの値は既定で ALL になります。
パラメーターのプロパティ
| 型: | TargetType |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。