Anr

Optional

System.String

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

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

Credential

Optional

System.Management.Automation.PSCredential

The Credential parameter specifies the user name and password to use to access the Active Directory directory service.

Database

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Database parameter specifies the database from which to get the mailbox. You can use the following values:

• GUID of the database
  
  
• Database name
  
  
• Server name\database name
  
  
• Server name\storage group\database name
  
  

If you do not specify the server name, the cmdlet will search for the database on the local server. If you have multiple databases with the same name on the same server, you must specify the storage group.

This parameter cannot be used in conjunction with the Filter parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to use to access Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

Filter

Optional

System.String

The Filter parameter specifies one or more attributes that are used to restrict the mailboxes that are returned by the query.

This parameter cannot be used in conjunction with the Database parameter.

For detailed information about the filterable properties, see Filterable Properties for the -Filter Parameter in Exchange 2007 RTM.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter identifies the mailbox. You can use one of the following values:

• GUID
  
  
• Distinguished name (DN)
  
  
• Domain\Account
  
  
• User principal name (UPN)
  
  
• LegacyExchangeDN
  
  
• SmtpAddress
  
  
• Alias
  
  

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter specifies an organizational unit (OU), and is used to limit the results. If you use this parameter, you will only get mailboxes in the container that you specify. You can use either the OU or the domain name. If you use the OU, you must specify the canonical name of the OU.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest, and if you do not use this parameter, it is possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information.

Note:
By default, the recipient scope is set to the domain that hosts your Exchange servers.

RecipientTypeDetails

Optional

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

The RecipientTypeDetails parameter specifies the type of recipients that are returned. Recipient types in Microsoft Exchange Server 2007 are divided into recipient types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory with an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails parameter. For example, a conference room mailbox has RecipientTypeDetails set to RoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox.

For this command, the available recipient type details are:

• RoomMailbox
  
  
• EquipmentMailbox
  
  
• LegacyMailbox
  
  
• LinkedMailbox
  
  
• UserMailbox
  
  
• SharedMailbox
  
  

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all mailboxes that match the query, use "unlimited" for the value of this parameter. The default value is 1000.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies an individual server and is used to limit the results. If you use this parameter, you will only get mailboxes that reside on the server that you specify. Use the common name of the server that you want to specify.

SortBy

Optional

System.String

The SortBy parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. You can sort by the following attributes:

• Alias
  
  
• Display name
  
  
• Name
  
  

The results will be sorted in ascending order.