Get-CsOnlineUMMailBox

 

Topic Last Modified: 2016-08-21

Use the Get-CsOnlineUMMailBox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled.

Get-CsOnlineUMMailBox [-AccountPartition <String>] [-Anr <String>] [-Credential <PSCredential>] [-DomainController <String>] [-Filter <String>] [-Force <SwitchParameter>] [-Identity <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <String>] [-OrganizationalUnit <String>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Int32>] [-SortBy <String>] [-TenantId <Guid>]

This example displays a summary list of all the UM-enabled mailboxes in your organization

Get-UMMailbox

This example displays detailed information for the UM-enabled mailbox for tonysmith@contoso.com.

Get-UMMailbox -Identity tonysmith@contoso.com | Format-List

Use the Get-CsOnlineUMMailBox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled.

 

ParameterRequiredTypeDescription

AccountPartition

Optional

System.Boolean

Anr

Optional

System.String

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

Credential

Optional

System.Management.Automation.PSCredential

This parameter is available only in on-premises Skype for Business Server.

The Credential parameter specifies the user name and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name.

Filter

Optional

System.String

The Filter parameter indicates the OPath filter used to filter recipients.

For more information about the filterable properties, see Filterable Properties for the -Filter Parameter.

Force

Optional

System.Management.Automation.SwitchParameter

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Skype for Business Server.

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access UNRESOLVED_TOKEN_VAL(exADNoMk) objects that aren't currently available in the default scope.

Using the IgnoreDefaultScope switch introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

Organization

Optional

System.String

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter is available only in on-premises Skype for Business Server.

The OrganizationalUnit parameter filters the results based on the object's location in UNRESOLVED_TOKEN_VAL(exADNoMk). Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Skype for Business Server.

The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch.

NoteNote:
By default, the recipient scope is set to the domain that hosts your UNRESOLVED_TOKEN_VAL(exExchangeNoVersion) servers.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

Specifies the number of records returned by the cmdlet. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0, the command will run, but no data will be returned.

SortBy

Optional

System.String

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto <Property1>,<Property2>... to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

  • Name

  • DisplayName

  • ServerLegacyDN

TenantID

Optional

System.Guid

The tenant's ID.

 
Show: