Set-OfflineAddressBook
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。
使用 Set-OfflineAddressBook 指令程式來修改離線通訊錄 (OAB) 設定。
在Exchange Online中,此 Cmdlet 只能在 [通訊清單] 角色中使用,而且根據預設,角色不會指派給任何角色群組。 若要使用此 Cmdlet,您必須將 [通訊清單] 角色新增至角色群組 (例如,新增至組織管理角色群組) 。 如需詳細資訊,請 參閱將角色新增至角色群組。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
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>]
Description
您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 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
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
您可以使用 Get-AddressList 和 Get-GlobalAddressList Cmdlet 來尋找通訊清單及全域通訊清單的識別值。
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 的必要內容。 您不需要使用此參數指定值。
從 Exchange 2003 移轉 OAB 時,共存環境中會使用此參數。
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 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 例如,具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停,可強制您在繼續之前確認命令。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (例如,New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 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 參數會指定此 Cmdlet 用來向 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 值。 具備此能力的仲裁信箱亦稱為組織信箱。 您可以使用可唯一識別信箱的任何值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- Domain\Username
- 電子郵件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 使用者識別碼或使用者主要名稱 (UPN)
此參數的預設值是名為 SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} 的組織信箱。
單一組織信箱可以產生多個 OAB (您可以在多個 OAB) 的設定中針對此參數使用相同的值,但在 Exchange 2013 CU5 或更新版本中,OAB 只能由單一組織信箱產生, (此參數不接受多個值) 。 為了要在其他組織信箱中有可用的 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:組織中的任何 OAB 虛擬目錄都可以接受下載 OAB 的要求。 您無法搭配 VirtualDirectories 參數使用此設定。
- $false:只有 VirtualDirectories 參數所指定的 OAB 虛擬目錄接受下載 OAB 的要求。 這是預設值。
在 Exchange 2013 CU7 或更新版本中,建議您使用此參數的值$true。 在任何信箱伺服器上的用戶端存取服務,可透過 Proxy 將傳入 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 (64KB)。
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 (64KB)。
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
此參數僅適用于 2010 Exchange Server。
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中,此屬性的唯讀值會顯示在 Coordinated Universal Time (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 會散發到所有其他組織信箱。
- $false:OAB 不會散發到其他組織信箱。 這是預設值。
只有當您有多個組織信箱時,此參數的值才有意義,而且只有在具有多個 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 版本。 有效值為:
- 第 2 版 (需要公用資料夾散發)
- 第 3 版 (需要公用資料夾散發)
- 版本 4 (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 虛擬目錄。 這些位置會在自動探索服務中通告。
您可以使用任何可唯一識別虛擬目錄的值。 例如:
- 名稱或伺服器名稱
- 辨別名稱 (DN)
- GUID
Name 值會使用來自虛擬目錄屬性的語法 "VirtualDirectoryName (WebsiteName)"
。 您可以使用 語 VirtualDirectoryName*
法來指定萬用字元 (*) ,而不是預設網站。
此參數的預設值是信箱伺服器上 (前端) 和後端 OAB 虛擬目錄的用戶端存取服務,這些信箱伺服器會將 OAB 世代信箱 (GeneratingMailbox 參數或 SystemMailbox{bb558c35-97f1-4cb 9-8ff7-d53741dc928c}) 當您建立 OAB (時,例如 Mailbox01\OAB (Default Web Site) ,Mailbox01\OAB (Exchange 後端) 。
若要使用此參數,GlobalWebDistributionEnabled 參數的值必須為 $false。
在 Exchange 2013 CU7 或更新版本中,建議您將此參數設定為 $null,然後將 GlobalWebDistributionEnabled 參數設定為 $true,因為任何信箱伺服器上的用戶端存取服務都可以將傳入的 OAB 下載要求 Proxy 至正確的位置。
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 會指定是否要在將 ZIP 檔案上傳至伺服器之前,先在 OAB 檔案上使用 ZIP 檔案壓縮。 有效值為:
- $true:ZIP OAB 檔案。
- $false:不要 ZIP OAB 檔案。 這是預設值。
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
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。