Get-EXOMailbox

Ссылка

Модуль:: ExchangePowerShell

Применяется к:: Exchange Online

Этот командлет доступен только в модуле PowerShell Exchange Online. Дополнительные сведения см. в разделе Сведения о модуле PowerShell Exchange Online.

Используйте командлет Get-EXOMailbox для просмотра объектов и атрибутов почтовых ящиков, заполнения страниц свойств или предоставления сведений о почтовом ящике другим задачам.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

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

Описание

По умолчанию этот командлет возвращает сводный список (минимальный набор свойств) всех почтовых ящиков в организации.

Примеры

Пример 1

Get-EXOMailbox -ResultSize unlimited

В этом примере возвращается сводный список всех почтовых ящиков в организации и содержится набор минимальных выходных свойств по умолчанию. Чтобы вернуть дополнительные свойства, используйте параметры Properties и (или) PropertySets.

Пример 2

Get-EXOMailbox -PropertySets 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
Alias (Псевдоним)

Этот параметр нельзя использовать с параметрами 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

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

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

-ExternalDirectoryObjectId

Параметр ExternalDirectoryObjectId определяет почтовый ящик, который требуется просмотреть с помощью ObjectId в Azure Active Directory.

Этот параметр нельзя использовать с параметрами 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), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные.
Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах см. в разделах Наборы свойств Get-EXOMailbox и Фильтруемые свойства для параметра Filter.
ComparisonOperator — это оператор сравнения OPATH (например -eq , для равных и -like для сравнения строк). Подробнее об операторах сравнения см. в статье about_Comparison_Operators.
Value — это значение свойства для поиска. Заключите текстовые значения и переменные в одиночные кавычки ('Value' или '$Variable'). Если значение переменной содержит одиночные кавычки, необходимо определить (избежать) одиночные кавычки, чтобы правильно развернуть переменную. Например, вместо '$User' используйте '$($User -Replace "'","''")'. Не заключайте целые числа или системные значения в кавычки (например, используйте 500, $true, $false, или $null вместо них).

Можно связать несколько условий поиска вместе с помощью логических операторов -and и -or. Например, "Criteria1 -and Criteria2" или "(Criteria1 -and Criteria2) -or Criteria3".

Подробные сведения о фильтрах OPATH в Exchange см. в разделе Дополнительные сведения о синтаксисе OPATH.

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

-GroupMailbox

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

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

-Identity

Параметр Identity указывает почтовый ящик, который требуется просмотреть. Для максимальной производительности рекомендуется использовать следующие значения:

Идентификатор пользователя или имя участника-пользователя
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.

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

-Migration

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

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

-OrganizationalUnit

Параметр OrganizationalUnit фильтрует результаты по расположению объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, который можно отобразить с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:

Имя
Имя
различающееся имя (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 указывает свойства, возвращаемые в выходных данных этого командлета. Вы можете указать несколько значений, разделив их запятыми.

Дополнительные сведения о доступных свойствах см. в разделе Наборы свойств 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 задает логическое группирование свойств, возвращаемых в выходных данных этого командлета. Допустимые значения:

Все
Минимум (это значение по умолчанию)
AddressList
Архив
Аудит
Пользовательские
Delivery
Hold
Контроль
Move
Политика
PublicFolder
Quota
Ресурс
Хранение
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

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

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
Устаревшая версияMailbox
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 указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 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 определяет почтовый ящик, который нужно просмотреть по имени участника-пользователя (например, 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
Имя _сервера
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

Входные данные

Выходные данные

Обратная связь

Обратная связь

Дополнительные ресурсы