通过

Set-OfflineAddressBook

  • 参考
模块:
ExchangePowerShell
适用于:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。

使用 Set-OfflineAddressBook cmdlet 可以修改脱机通讯簿 (OAB) 设置。

在 Exchange Online 中，此 cmdlet 仅在“地址列表”角色中可用，默认情况下，该角色不会分配给任何角色组。 若要使用此 cmdlet，需要将“地址列表”角色添加到角色组 (例如“组织管理”角色组) 。 有关详细信息，请参阅向角色组添加角色。

有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。

语法

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>]

说明

您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 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

Update 如果值包含空格或需要引号，请使用以下语法： "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 (不明确名称解析) 、Value 或 Indicator 的值。

若要将此参数重置回默认值，请使用 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)
  • 域\用户名
  • 电子邮件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 用户 ID 或用户主体名称 (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。 任何邮箱服务器上的客户端访问服务都能将传入的 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 的任意值。 例如：

  • Name 或 \Name
  • 可分辨名称 (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 KB)。

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 KB)。

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.)
  • “星期日 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 将分发到所有其他组织邮箱。
  • $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 生成邮箱 (GenerationMailbox 参数或 SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) 例如创建 OAB (Mailbox01\OAB (默认网站) ，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：ZIP OAB 文件。
  • $false：不要压缩 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

若要了解此 cmdlet 接受的输入类型，请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空，则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型（亦称为"输出类型"），请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空，则表明此 cmdlet 不返回任何数据。