Set-OfflineAddressBook
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
オフライン アドレス帳 (OAB) の設定を変更するには、Set-OfflineAddressBook コマンドレットを使用します。
Exchange Online で、このコマンドレットはアドレス一覧の役割でのみ使用できます。既定では、この役割は役割グループに割り当てられていません。 このコマンドレットを使用するには、アドレス一覧の役割を役割グループ (たとえば、組織の管理 役割グループ) に追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-OfflineAddressBook
[-Identity] <OfflineAddressBookIdParameter>
[-AddressLists <AddressBookBaseIdParameter[]>]
[-ApplyMandatoryProperties]
[-ConfiguredAttributes <MultiValuedProperty>]
[-Confirm]
[-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>]
[-FullOabDownloadPreventionThreshold <Int32>]
[-GeneratingMailbox <MailboxIdParameter>]
[-GlobalWebDistributionEnabled <Boolean>]
[-IsDefault <Boolean>]
[-MaxBinaryPropertySize <Int32>]
[-MaxMultivaluedBinaryPropertySize <Int32>]
[-MaxMultivaluedStringPropertySize <Int32>]
[-MaxStringPropertySize <Int32>]
[-Name <String>]
[-PublicFolderDistributionEnabled <Boolean>]
[-Schedule <Schedule>]
[-ShadowMailboxDistributionEnabled <Boolean>]
[-UpgradeFromE14]
[-UseDefaultAttributes]
[-Versions <MultiValuedProperty>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
[-WhatIf]
[-ZipOabFilesBeforeUploading <Boolean>]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-OfflineAddressBook -Identity "Default Offline Address Book" -VirtualDirectories $null -GlobalWebDistributionEnabled $true
この例では、既定のオフライン アドレス帳という名前の OAB を構成して、組織内のすべての OAB 仮想ディレクトリからダウンロード要求のために使用できるようにします。
例 2
Set-OfflineAddressBook -Identity "\Default Offline Address Book" -GeneratingMailbox OABGen2
この例では、OAB の生成を行う組織のメールボックスを変更します。
パラメーター
-AddressLists
AddressLists パラメーターは、OAB に含まれるアドレス一覧またはグローバル アドレス一覧を指定します。 アドレス一覧を一意に識別する任意の値を使用できます。 例:
- 名前
- 識別名 (DN)
- GUID
Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"
Get-AddressList と Get-GlobalAddressList のコマンドレットを使って、アドレス一覧およびグローバル アドレス一覧の識別値を検索することができます。
Type: | AddressBookBaseIdParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ApplyMandatoryProperties
ApplyMandatoryProperties スイッチは、レガシ OAB の必須プロパティを更新するかどうかを指定します。 このスイッチで値を指定する必要はありません。
このスイッチは、OAB が Exchange 2003 から移行されたときに共存環境で使用されました。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ConfiguredAttributes
ConfiguredAttributes パラメーターは、OAB で使用できる受信者 MAPI プロパティを指定します。 このパラメーターは構文を使用します "Name1,Type1","Name2,Type2",..."NameN,TypeN"
。Name は MAPI プロパティの名前 (MobileTelephoneNumber など)、Type は値 ANR (あいまいな名前解決)、値、またはインジケーターです。
このパラメーターをリセットして既定値に戻すには、UseDefaultAttributes スイッチを使用します。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DiffRetentionPeriod
DiffRetentionPeriod パラメーターは、OAB の差分ファイルがサーバーに格納される日数を指定します。 有効な値は、7 から 1825 の整数、または値 unlimited です。 既定値は 30 です。
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-FullOabDownloadPreventionThreshold
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | Int32 |
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 |
-GeneratingMailbox
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
GeneratingMailbox パラメーターは、OAB が生成される調停メールボックスを指定します。 具体的には、調停メールボックスに PersistedCapability プロパティの OrganizationCapabilityOABGen 値が含まれている必要があります。 この機能を持つ調停メールボックスは、組織のメールボックスとも呼ばれます。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
このパラメーターの既定値は、SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} という名前の組織のメールボックスです。
1 つのorganizationメールボックスで複数の OAB を生成できますが (複数の OAB の設定でこのパラメーターに同じ値を使用できます)、Exchange 2013 CU5 以降では、OAB は 1 つのorganization メールボックスによってのみ生成できます (このパラメーターは複数の値を受け入れられません)。 他の組織のメールボックスで使用可能な OAB の読み取り専用のコピー (シャドウ コピーとも呼ばれる) を持つには、ShadowMailboxDistributionEnabled パラメーターを使います。
Type: | MailboxIdParameter |
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 |
-GlobalWebDistributionEnabled
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
GlobalWebDistributionEnabled パラメーターは、組織内のすべての OAB 仮想ディレクトリで OAB をダウンロードする要求を受け入れられるようにするかどうかを指定します。 自動検出サービスによって、これらの場所が通知されます。 有効な値は次のとおりです。
- $true: organization内のすべての OAB 仮想ディレクトリは、OAB のダウンロード要求を受け入れます。 VirtualDirectories パラメーターでは、この設定を使用できません。
- $false: VirtualDirectories パラメーターで指定された OAB 仮想ディレクトリのみが、OAB のダウンロード要求を受け入れます。 これは既定の値です。
Exchange 2013 CU7 以降では、このパラメーターに$true値を使用することをお勧めします。 任意のメールボックス サーバー上のクライアント アクセス サービスは、受信 OAB ダウンロード要求を正しい場所にプロキシできます。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
Identity パラメーターは、変更する OAB を指定します。 OAB を一意に識別する任意の値を使用できます。 次に例を示します。
- 名前または \名前
- 識別名 (DN)
- GUID
Type: | OfflineAddressBookIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IsDefault
IsDefault パラメーターは、OAB の指定のないすべてのメールボックスとメールボックス データベースで OAB を使用するかどうかを指定します。 有効な値は次のとおりです。
- $true: OAB は既定の OAB です。
- $false: OAB は既定の OAB ではありません。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MaxBinaryPropertySize
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
MaxBinaryPropertySize パラメーターは、OAB のバイナリ属性の切り詰め前の最大サイズ (バイト) を指定します。 有効な値は、0 から 999999999 の整数です。 既定値は、65536 です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxMultivaluedBinaryPropertySize
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
MaxMultivaluedBinaryPropertySize パラメーターは、OAB の複数値バイナリ属性の切り詰め前の最大サイズ (バイト) を指定します。 有効な値は、0 から 999999999 の整数です。 既定値は、65536 (64 キロバイト) です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxMultivaluedStringPropertySize
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
MaxMultivaluedStringPropertySize パラメーターは、OAB の複数値文字列属性の切り詰め前の最大サイズを指定します。 有効な値は、0 から 999999999 の整数です。 既定値は、65536 (64 キロバイト) です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MaxStringPropertySize
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
MaxStringPropertySize パラメーターは、文字列属性の切り詰め前の最大サイズ (バイト) を指定します。 有効な値は、0 から 999999999 の整数です。 既定値は 3400 です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Name
Name パラメーターは、OAB の一意の名前を指定します。 最大の長さは 64 文字です。 値にスペースが含まれている場合は、値を引用符で囲んでください。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PublicFolderDistributionEnabled
このパラメーターは Exchange Server 2010 でのみ使用できます。
PublicFolderDistributionEnabled パラメーターは、OAB をパブリック フォルダー経由で配布するかどうかを指定します。 PublicFolderDistributionEnabled パラメーターを $true の値に設定すると、パブリック フォルダー経由で配布される OAB が設定されます。 既定値は $true です。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Schedule
このパラメーターは、Exchange 2010 でのみ機能します。
Exchange 2013 以降では、このパラメーターは OAB 生成スケジュールの責任を負いません。 詳細については、「 Exchange でオフライン アドレス帳の生成スケジュールを変更する」を参照してください。
Schedule パラメーターは、Exchange 2010 以前で OAB を生成する間隔を指定します。
このパラメーターの構文は です。 StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]
日数は次の値を使用できます。
- その日のフル ネーム。
- 日付の省略名。
- 0 から 6 までの整数 。0 = 日曜日。
時刻を 24 時間形式で入力し、AM/PM 値を省略できます。 時刻を 12 時間形式で入力する場合は、時刻と AM/PM 値の間にスペースを含めます。
日付/時刻形式を混在させ、一致させることができます。
開始時刻と終了時刻は 15 分以上離れている必要があります。 分は 0、15、30、または 45 に切り捨てられます。
次に、いくつかの例を示します:
- "Sun.11:30 PM-Mon.1:30 AM"
- "6.22:00-6.22:15" (土曜日の午後 10:00 から土曜日の午後 10:15 まで実行されます。
- "Sun.1:15 AM-Monday.23:00"
注: Exchange Onlineでは、このプロパティの読み取り専用値は協定世界時 (UTC) に表示されます。
Type: | Schedule |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ShadowMailboxDistributionEnabled
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
ShadowMailboxDistributionEnabled パラメーターは、OAB (シャドウ コピーとも呼ばれる) の読み取り専用のコピーを、その他の OAB 生成メールボックス (組織のメールボックスとも呼ばれる) すべてに配布するかどうかを指定します。 これにより、OAB をダウンロードするための要求のエンドポイントにするメールボックス サーバーを追加することで、ユーザーが低速の WAN リンク経由で OAB をダウンロードすることがないようにします。 有効な値は次のとおりです。
- $true: OAB は、他のすべてのorganizationメールボックスに配布されます。
- $false: OAB は他のorganizationメールボックスに配布されません。 これは既定の値です。
このパラメーターの値は、複数のorganizationメールボックスがある場合にのみ意味があり、複数の Active Directory サイトを持つ Exchange 組織でのみ役立ちます。
Type: | Boolean |
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 |
-UpgradeFromE14
このパラメーターは、Microsoft の内部使用のために予約されています。
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 |
-UseDefaultAttributes
UseDefaultAttributes スイッチは、OAB で使用可能な受信者の MAPI プロパティを既定の一覧に戻すかどうかを指定します。 このスイッチで値を指定する必要はありません。
このスイッチを使用して、ConfiguredAttributes パラメーターを使って既定の一覧に対して行った変更を元に戻すことができます。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Versions
Versions パラメーターは、クライアントのダウンロード用に生成される OAB のバージョンを指定します。 有効な値は次のとおりです。
- Version2 (パブリック フォルダーの配布が必要)
- Version3 (パブリック フォルダーの配布が必要)
- Version4 (Exchange 2010 以降の既定値。Exchange 2013 以降で使用可能な唯一の値)
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-VirtualDirectories
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
VirtualDirectories パラメーターは、OAB のダウンロード要求を受け入れる OAB 仮想ディレクトリを指定します。 自動検出サービスで、これらの場所が通知されます。
仮想ディレクトリを一意に識別する任意の値を使用できます。 例:
- 名前またはサーバー\Name
- 識別名 (DN)
- GUID
Name 値は、仮想ディレクトリのプロパティの構文 "VirtualDirectoryName (WebsiteName)"
を使用します。 構文 VirtualDirectoryName*
を使用して、既定の Web サイトの代わりにワイルドカード文字 (*) を指定できます。
このパラメーターの既定値は、OAB を作成したときに OAB 生成メールボックス (GeneratingMailbox パラメーターまたは SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) を保持するメールボックス サーバー上のクライアント アクセス サービス (フロントエンド) とバックエンド OAB 仮想ディレクトリです (例: Mailbox01\OAB (既定の Web サイト)、Mailbox01\OAB (Exchange バックエンド)。
このパラメーターを使用するには、GlobalWebDistributionEnabled パラメーターの値を $false にする必要があります。
Exchange 2013 CU7 以降では、このパラメーターを $null に設定してから、GlobalWebDistributionEnabled パラメーターを $true に設定することをお勧めします。これは、メールボックス サーバー上のクライアント アクセス サービスが受信 OAB ダウンロード要求を適切な場所にプロキシできるためです。
Type: | VirtualDirectoryIdParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ZipOabFilesBeforeUploading
ZipOabFilesBeforeUploading では、OAB ファイルをサーバーにアップロードする前に ZIP ファイル圧縮を使用するかどうかを指定します。 有効な値は次のとおりです。
- $true: OAB ファイルを ZIP します。
- $false: OAB ファイルを ZIP にしないでください。 これは既定の値です。
Type: | Boolean |
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 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。