Get-EXOMailbox

参考

模块:: ExchangePowerShell

适用于:: Exchange Online

此 cmdlet 仅在 Exchange Online PowerShell 模块中可用。有关详细信息，请参阅关于 Exchange Online PowerShell 模块。

使用 Get-EXOMailbox cmdlet 查看邮箱对象和属性、填充属性页或向其他任务提供邮箱信息。

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

语法

Get-EXOMailbox
   [[-Identity] <String>]
   [-Archive]
   [-Async]
   [-ExternalDirectoryObjectId <Guid>]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-PrimarySmtpAddress <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [-UserPrincipalName <String>]
   [<CommonParameters>]

Get-EXOMailbox
   [-Anr <String>]
   [-Archive]
   [-Async]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [<CommonParameters>]

说明

默认情况下，此 cmdlet 返回一个摘要列表， (组织中所有邮箱的最小属性集) 。

示例

示例 1

Get-EXOMailbox -ResultSize unlimited

此示例返回组织中所有邮箱的摘要列表，并包含默认的一组最小输出属性。若要返回其他属性，请使用 Properties 和/或 PropertySets 参数。

示例 2

Get-EXOMailbox -PropertySets Archive

此示例返回 Archive 属性集中定义的属性。有关这些属性的完整列表，请参阅 Get-EXOMailbox 属性集。

示例 3

Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit

此示例返回组织中所有邮箱的摘要列表，并包含以下属性：

存档和审核属性集中的属性。
Name 和 DistinguishedName 属性。

示例 4

Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias

此示例返回邮箱 John@contoso.com的指定属性。

参数

-Anr

Anr 参数指定字符串，用于执行模糊名称解析 (ANR) 搜索。可以指定部分字符串，并搜索其属性与该字符串匹配的对象。搜索的默认属性是：

CommonName (CN)
DisplayName
FirstName
LastName
别名

不能将此参数与 ExternalDirectoryObjectId、Identity、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Archive

存档开关按已启用存档的邮箱筛选结果， (仅) 返回具有存档邮箱的邮箱。不必为此开关指定值。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Async

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ExternalDirectoryObjectId

ExternalDirectoryObjectId 参数标识要通过 Azure Active Directory 中的 ObjectId 查看的邮箱。

不能将此参数与 Anr、Identity、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Filter

Filter 参数使用 OPATH 语法按指定的属性和值筛选结果。搜索条件使用语法 "Property -ComparisonOperator 'Value'"。

将整个 OPATH 筛选器括在双引号“”中。如果筛选器包含系统值 (，例如 $true、 $false或 $null) ，请改用单引号 ' 。虽然此参数是一个字符串 (不是) 的系统块，但也可以使用大括号 { }，但前提是筛选器不包含变量。
属性是可筛选的属性。有关可筛选属性的详细信息，请参阅 Get-EXOMailbox 属性集和 Filterable 属性的 Filter 参数。
ComparisonOperator 是一个 OPATH 比较运算符， (例如 -eq 用于等于和 -like 字符串比较) 。有关比较运算符的详细信息，请参阅 about_Comparison_Operators。
Value 是要搜索的属性值。将文本值和变量括在单引号 ('Value' 或 '$Variable') 。如果变量值包含单引号，则需要识别 (转义) 单引号才能正确展开变量。例如，使用 '$($User -Replace "'","''")'而不是 '$User'。不要将整数或系统值括在引号 (例如，改用 500、 $true、 $false或 $null) 。

可以使用逻辑运算符 -and 和 -or将多个搜索条件链接在一起。例如，"Criteria1 -and Criteria2" 或 "(Criteria1 -and Criteria2) -or Criteria3"。

有关 Exchange 中的 OPATH 筛选器的详细信息，请参阅其他 OPATH 语法信息。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-GroupMailbox

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Identity

Identity 参数指定要查看的邮箱。为了获得最佳性能，建议使用以下值：

用户 ID 或用户主体名称 (UPN)
GUID

否则，可以使用唯一标识邮箱的任何值。例如：

名称
别名
可分辨名称 (DN)
域\用户名
电子邮件地址
LegacyExchangeDN
SamAccountName

不能将此参数与 Anr、ExternalDirectoryObjectId、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-InactiveMailboxOnly

InactiveMailboxOnly 开关指定是否仅返回结果中的非活动邮箱。不必为此开关指定值。

非活动邮箱是在软删除之前置于诉讼保留或就地保留的邮箱。除非删除该保留，否则会一直保留非活动邮箱的内容。

若要在结果中同时返回活动邮箱和非活动邮箱，请不要使用此开关。请改用 IncludeInactiveMailbox 开关。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-IncludeInactiveMailbox

IncludeInactiveMailbox 开关指定是否在结果中包括非活动邮箱。不必为此开关指定值。

非活动邮箱是在软删除之前置于诉讼保留或就地保留的邮箱。除非删除该保留，否则会一直保留非活动邮箱的内容。

若要在结果中仅返回非活动邮箱，请不要使用此开关。请改用 InactiveMailboxOnly 开关。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-MailboxPlan

MailboxPlan 参数按邮箱计划筛选结果。使用此参数时，仅将那些分配了指定的邮箱计划的邮箱返回在结果中。可以使用任何能够唯一标识该邮箱计划的值。例如：

名称
别名
显示名称
可分辨名称 (DN)
GUID

邮箱计划指定基于云的组织中的邮箱用户可用的权限和功能。您可以使用 Get-MailboxPlan cmdlet 查看可用的邮箱计划。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Migration

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-OrganizationalUnit

OrganizationUnit 参数根据对象在 Active Directory 中的位置筛选结果。只返回存在于指定位置的对象。此参数的有效输入是使用 Get-OrganizationalUnit cmdlet 可见的组织单位 (OU) 或域。可以使用任何能够唯一标识此 OU 或域的值。例如：

名称
名称
可分辨名称 (DN)
GUID

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress 按主 SMTP 电子邮件地址 (标识要查看的邮箱， navin@contoso.com 例如，) 。

不能将此参数与 Anr、ExternalDirectoryObjectId、Identity 或 UserPrincipalName 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Properties

Properties 参数指定在此 cmdlet 的输出中返回的属性。可以指定用逗号分隔的多个值。

有关可用属性的详细信息，请参阅 Get-EXOMailbox 属性集。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PropertySets

PropertySets 参数指定在此 cmdlet 的输出中返回的属性的逻辑分组。有效值包含:

全部
最小 (这是默认值)
AddressList
存档
Audit
自定义警报
交货
Hold
裁决
移动
Policy
PublicFolder
配额
资源
保留
SCL
SoftDelete
StatisticsSeed

可以指定用逗号分隔的多个值。

有关每个属性集中包含的属性的详细信息，请参阅 Get-EXOMailbox 属性集。

Type:	PropertySet[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PublicFolder

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientTypeDetails

RecipientTypeDetails 参数按指定的邮箱子类型筛选结果。有效值包含:

DiscoveryMailbox
EquipmentMailbox
GroupMailbox
LegacyMailbox
LinkedMailbox
LinkedRoomMailbox
RoomMailbox
SchedulingMailbox
SharedMailbox
TeamMailbox
UserMailbox

可以指定用逗号分隔的多个值。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ResultSize

ResultSize 参数指定了要返回的结果的最大数量。若要返回所有与查询相匹配的请求，则请将此参数的值设为无限制。默认值为 1000。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-SoftDeletedMailbox

需要 SoftDeletedMailbox 开关才能在结果中返回软删除的邮箱。不必为此开关指定值。

软删除的邮箱是仍然可以恢复的已删除邮箱。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-UserPrincipalName

UserPrincipalName 参数标识要由 UPN (查看的邮箱， navin@contoso.onmicrosoft.com 例如，) 。

不能将此参数与 Anr、ExternalDirectoryObjectId、Identity 或 PrimarySmtpAddress 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

输入

Input types

以下Get-Mailbox参数在 Get-EXOMailbox 中不可用或不起作用：

Async
GroupMailbox
迁移
PublicFolder
SortBy

输出

Output types

Get-EXOMailbox 的输出中不包括以下属性：

RunspaceId
Servername
AdminDisplayVersion
DelayReleaseHoldApplied
EnforcedTimestamps
说明
OriginatingServer
IsValid
ObjectState

通过

Get-EXOMailbox

语法

说明

示例

示例 1

示例 2

示例 3

示例 4

参数

-Anr

-Archive

-Async

-ExternalDirectoryObjectId

-Filter

-GroupMailbox

-Identity

-InactiveMailboxOnly

-IncludeInactiveMailbox

-MailboxPlan

-Migration

-OrganizationalUnit

-PrimarySmtpAddress

-Properties

-PropertySets

-PublicFolder

-RecipientTypeDetails

-ResultSize

-SoftDeletedMailbox

-UserPrincipalName

输入

输出

反馈

其他资源