Get-CASMailbox
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.
Используйте командлет Get-CASMailbox для просмотра параметров клиентского доступа, настроенных в почтовых ящиках.
Примечание. В Exchange Online PowerShell вместо этого рекомендуется использовать командлет Get-EXOCASMailbox. Дополнительные сведения см. в статье Connect to Exchange Online PowerShell.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
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>]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
Переключатель ActiveSyncDebugLogging показывает фактическое значение свойства ActiveSyncDebugLogging почтового ящика. Указывать значение для этого параметра необязательно.
Если этот параметр не используется, всегда отображается значение $false.
Чтобы увидеть это значение, необходимо использовать командлет форматирования. Например, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List.
| 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 |
-ActiveSyncSuppressReadReceipt
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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 |
-Anr
Параметр Anr определяет строку, по которой будет выполнен поиск с разрешением неоднозначных имен (ANR). Можно задать частичное строковое значение и выполнить поиск объектов с атрибутом, который совпадает с этой строкой. По умолчанию искомыми атрибутами являются:
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- Alias (Псевдоним)
| 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 |
-Credential
Параметр Credential указывает имя пользователя и пароль, используемые для выполнения этой команды. Как правило, этот параметр используется в сценариях, или если требуется указывать различные учетные данные, которые предоставляют необходимые разрешения.
Для этого параметра необходимо создавать и передавать объект учетных данных. Этот объект создается с помощью командлета Get-Credential. Для получения дополнительной информации см. Get-Credential.
| Type: | PSCredential |
| 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 указывает контроллер домена, который используется этим командлетом для чтения или записи данных в 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 |
-Filter
Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".
- Заключите весь фильтр OPATH в двойные кавычки "". Если фильтр содержит системные значения (например,
$true,$falseили$null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные. - Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах см. в разделе Фильтруемые свойства для параметра 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
Параметр Identity определяет почтовый ящик, который требуется просмотреть. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.
- Имя
- Псевдоним
- различающееся имя (DN);
- различающееся имя (DN);
- Домен\Имя пользователя
- Адрес электронной почты
- GUID
- LegacyExchangeDN
- SamAccountName
- Идентификатор пользователя или имя участника-пользователя
| Type: | MailboxIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IgnoreDefaultScope
Параметр IgnoreDefaultScope указывает команде игнорировать параметр области получателя по умолчанию для сеанса Exchange PowerShell и использовать в качестве области весь лес. Указывать значение для этого параметра необязательно.
Этот параметр позволяет команде получать доступ к объектам Active Directory, которые в настоящее время недоступны в области по умолчанию, но также вводит следующие ограничения:
- При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
- При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
| 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 |
-Monitoring
Этот параметр доступен только в локальной среде Exchange.
Параметр Мониторинг необходим для возврата почтовых ящиков мониторинга в результатах. Указывать значение для этого параметра необязательно.
Почтовые ящики мониторинга связаны с управляемой доступностью и службой диспетчера работоспособности Exchange, а свойство RecipientTypeDetails имеет значение MonitoringMailbox.
| Type: | SwitchParameter |
| 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 |
-OrganizationalUnit
Параметр OrganizationalUnit фильтрует результаты по расположению объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, которые возвращаются с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:
- Имя
- Имя
- различающееся имя (DN);
- GUID
| Type: | OrganizationalUnitIdParameter |
| 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 |
-ProtocolSettings
Переключатель ProtocolSettings возвращает имена серверов, порты TCP и методы шифрования для следующих параметров:
- ExternalImapSettings
- InternalImapSettings
- ExternalPopSettings
- InternalPopSettings
- ExternalSmtpSettings
- InternalSmtpSettings
Указывать значение для этого параметра необязательно.
Чтобы увидеть эти значения, необходимо использовать командлет форматирования. Например, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.
| 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 |
-ReadFromDomainController
Этот параметр доступен только в локальной среде Exchange.
Переключатель ReadFromDomainController указывает, что сведения будут считываться из контроллера домена в домене пользователя. Для этого переключателя не требуется указывать значение.
Для Set-AdServerSettings -ViewEntireForest $true включения всех объектов в лесу требуется параметр ReadFromDomainController. В противном случае команда может использовать глобальный каталог, содержащий устаревшие сведения. Кроме того, для получения сведений может потребоваться выполнить несколько итераций команды с параметром ReadFromDomainController.
По умолчанию в качестве области получателя задается домен, в котором размещаются серверы Exchange.
| 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 |
-ReadIsOptimizedForAccessibility
Параметр ReadIsOptimizedForAccessibility указывает, следует ли считывать значение свойства IsOptimizedForAccessibility в почтовом ящике (настроен ли почтовый ящик для использования облегчаемой версии Outlook в Интернете). Указывать значение для этого параметра необязательно.
| 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 |
-RecalculateHasActiveSyncDevicePartnership
Параметр RecalculateHasActiveSyncDevicePartnership пересчитывает значение свойства HasActiveSyncDevicePartnership для почтового ящика. Указывать значение для этого параметра необязательно.
Неверное значение автоматически обновляется.
| Type: | SwitchParameter |
| 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, Exchange Online |
-RecipientTypeDetails
Этот параметр доступен только в облачной службе.
Параметр RecipientTypeDetails фильтрует результаты по указанному подтипу получателя. Допустимые значения:
- DiscoveryMailbox
- EquipmentMailbox
- Устаревшая версияMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailUser
- RoomMailbox
- SharedMailbox
- TeamMailbox
- UserMailbox
Вы можете указать несколько значений, разделив их запятыми.
| Type: | RecipientTypeDetails[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Exchange Online Protection |
-ResultSize
Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.
| 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 |
-SortBy
Параметр SortBy указывает свойство, по которому необходимо сортировать результаты. Вы можете выполнять сортировку не более, чем по одному свойству одновременно. Результаты будут отсортированы в порядке возрастания.
Если в представлении по умолчанию нет свойства, по которым выполняется сортировка, можно добавить команду с | Format-Table -Auto Property1,Property2,...PropertyXпомощью . , чтобы создать новое представление, содержащее все свойства, которые нужно просмотреть. В именах свойств поддерживаются подстановочные знаки (*).
Можно выполнять сортировку по следующим свойствам:
- Имя
- DisplayName
- ServerLegacyDN
| 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 |
Входные данные
Input types
Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.
Выходные данные
Output types
Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по