Get-CASMailbox

Модуль:
Exchange PowerShell

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут быть эксклюзивными для той или иной среды.

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

Примечание. В Exchange Online PowerShell рекомендуется использовать командлет Get-EXOCASMailbox вместо этого командлета. Дополнительные сведения см. в статье Connect to Exchange Online PowerShell.

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

Синтаксис

AnrSet 

Get-CASMailbox
    [-Anr <String>]
    [-ActiveSyncDebugLogging]
    [-ActiveSyncSuppressReadReceipt]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-Monitoring]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ProtocolSettings]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-ReadIsOptimizedForAccessibility]
    [-RecalculateHasActiveSyncDevicePartnership]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [<CommonParameters>]

Identity 

Get-CASMailbox
    [[-Identity] <MailboxIdParameter>]
    [-ActiveSyncDebugLogging]
    [-ActiveSyncSuppressReadReceipt]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-Monitoring]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ProtocolSettings]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-ReadIsOptimizedForAccessibility]
    [-RecalculateHasActiveSyncDevicePartnership]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [<CommonParameters>]

Описание

Этот командлет возвращает различные параметры клиентского доступа для одного или нескольких почтовых ящиков. К этим параметрам относятся параметры для Outlook в Интернете, Exchange ActiveSync, POP3 и IMAP4.

Для его запуска необходимо получить соответствующие разрешения. Хотя в этой статье перечислены все параметры командлета, у вас может не быть доступа к некоторым параметрам, если они не включены в назначенные вам разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

Get-CASMailbox "Jeff Hay"

Этот пример возвращает значения указанных ниже параметров клиентского доступа для пользователя Jeff Hay.

  • ActiveSyncEnabled
  • OWAEnabled
  • PopEnabled
  • ImapEnabled
  • MapiEnabled

Пример 2

Get-CASMailbox tony@contoso.com | Format-List Imap*

В этом примере возвращаются все параметры IMAP4 для пользователя tony@contoso.com.

Пример 3

Get-CASMailbox chris@contoso.com | Format-List Ews*

В этом примере возвращаются все параметры веб-служб Exchange для пользователя chris@contoso.com.

Пример 4

Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select *

В этом примере в Exchange Online выходные данные командлета фильтруются так, чтобы включать только общие почтовые ящики.

Параметры

-ActiveSyncDebugLogging

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Переключатель ActiveSyncDebugLogging показывает фактическое значение свойства ActiveSyncDebugLogging почтового ящика. С этим параметром не нужно указывать значение.

Если этот параметр не используется, всегда отображается значение $false.

Чтобы увидеть это значение, необходимо использовать командлет форматирования. Например, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ActiveSyncSuppressReadReceipt

Применимо: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Anr

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр Anr определяет строку, по которой будет выполнен поиск с разрешением неоднозначных имен (ANR). Можно задать частичное строковое значение и выполнить поиск объектов с атрибутом, который совпадает с этой строкой. По умолчанию искомыми атрибутами являются:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • Alias

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AnrSet
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Credential

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр Credential указывает имя пользователя и пароль, используемые для выполнения этой команды. Как правило, этот параметр используется в сценариях, или если требуется указывать различные учетные данные, которые предоставляют необходимые разрешения.

Для этого параметра необходимо создавать и передавать объект учетных данных. Этот объект создается с помощью командлета Get-Credential. Для получения дополнительной информации см. Get-Credential.

Свойства параметров

Тип:PSCredential
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DomainController

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Этот параметр доступен только в локальной среде Exchange.

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.

Свойства параметров

Тип:Fqdn
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Filter

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".

  • Заключите весь фильтр OPATH в двойные кавычки " ". Если фильтр содержит системные значения (например, $true, $false или $null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные.
  • Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах см. в разделе Фильтруемые свойства для параметра Фильтр.
  • 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".

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Identity

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

  • Имя
  • Псевдоним
  • различающееся имя (DN);
  • различающееся имя (DN);
  • Домен\Имя пользователя
  • Адрес электронной почты
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Идентификатор пользователя или имя участника-пользователя

Внимание: значение $null или несуществующее значение параметра Identity возвращает все объекты так, как если бы вы выполнили команду Get- без параметра Identity. Убедитесь, что все списки значений для параметра Identity точны и не содержат несуществующих значений $null.

Свойства параметров

Тип:MailboxIdParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:1
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-IgnoreDefaultScope

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Ключ IgnoreDefaultScope указывает команде игнорировать параметр области получателей по умолчанию для сеанса Exchange PowerShell и использовать весь лес в качестве области. С этим параметром не нужно указывать значение.

Этот переключатель позволяет команде получать доступ к объектам Active Directory, которые в настоящее время недоступны в области по умолчанию, но также вводит следующие ограничения:

  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Monitoring

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Этот параметр доступен только в локальной среде Exchange.

Переключатель Monitoring необходим для возврата почтовых ящиков мониторинга в результатах. С этим параметром не нужно указывать значение.

Почтовые ящики мониторинга связаны с управляемой доступностью и службой диспетчера работоспособности Exchange и имеют значение свойства RecipientTypeDetails равному MonitoringMailbox.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OrganizationalUnit

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

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

  • Имя
  • Имя
  • различающееся имя (DN);
  • GUID

Свойства параметров

Тип:OrganizationalUnitIdParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ProtocolSettings

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Переключатель ProtocolSettings возвращает имена серверов, порты TCP и методы шифрования для следующих параметров:

  • ExternalImapSettings
  • InternalImapSettings
  • ExternalPopSettings
  • InternalPopSettings
  • ExternalSmtpSettings
  • InternalSmtpSettings

С этим параметром не нужно указывать значение.

Чтобы увидеть эти значения, необходимо использовать командлет форматирования. Например, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ReadFromDomainController

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Этот параметр доступен только в локальной среде Exchange.

Переключатель ReadFromDomainController указывает, что сведения будут считываться из контроллера домена в домене пользователя. С этим параметром не нужно указывать значение.

Команда: чтобы включить все объекты в лесу, Set-AdServerSettings -ViewEntireForest $true требуется ключ ReadFromDomainController. В противном случае команда может использовать глобальный каталог, содержащий устаревшие сведения. Кроме того, для получения информации может потребоваться выполнить несколько итераций команды с помощью переключателя ReadFromDomainController.

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

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ReadIsOptimizedForAccessibility

Применимо: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Переключатель ReadIsOptimizedForAccessibility указывает, следует ли читать значение свойства IsOptimizedForAccessibility в почтовом ящике (настроен ли почтовый ящик для использования облегченной версии Outlook в Интернете). С этим параметром не нужно указывать значение.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RecalculateHasActiveSyncDevicePartnership

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр RecalculateHasActiveSyncDevicePartnership пересчитывает значение свойства HasActiveSyncDevicePartnership для почтового ящика. С этим параметром не нужно указывать значение.

Неверное значение автоматически обновляется.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RecipientTypeDetails

Применимо: Exchange Online, встроенная надстройка безопасности для локальных почтовых ящиков

Этот параметр доступен только в облачной службе.

Параметр RecipientTypeDetails фильтрует результаты по указанному подтипу получателя. Допустимые значения:

  • DiscoveryMailbox
  • ОборудованиеПочтовый ящик
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • MailUser
  • RoomMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

Вы можете указать несколько значений, разделив их запятыми.

Свойства параметров

Тип:

RecipientTypeDetails[]

Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ResultSize

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.

Свойства параметров

Тип:Unlimited
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SortBy

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

Параметр SortBy указывает свойство, по которому необходимо сортировать результаты. Вы можете выполнять сортировку не более, чем по одному свойству одновременно. Результаты будут отсортированы в порядке возрастания.

Если представление по умолчанию не включает свойство, по которому выполняется сортировка, к команде | Format-Table -Auto Property1,Property2,...PropertyXможно добавить . создать новое представление, содержащее все свойства, которые требуется просмотреть. В именах свойств поддерживаются подстановочные знаки (*).

Можно выполнять сортировку по следующим свойствам:

  • Имя
  • DisplayName
  • ServerLegacyDN

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.

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

Input types

Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.

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

Output types

Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.