AccountDisabled

Required

System.Management.Automation.SwitchParameter

The AccountDisabled parameter specifies whether to create the mailbox in a disabled state. You don't have to specify a value with this parameter.

Arbitration

Required

System.Management.Automation.SwitchParameter

The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.

ArchiveDomain

Required

Microsoft.Exchange.Data.SmtpDomain

The ArchiveDomain parameter specifies the cloud-based services domain on which the archive associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com.

Discovery

Required

System.Management.Automation.SwitchParameter

The Discovery parameter specifies that this mailbox is a Discovery mailbox. Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. You don't have to include a value with this parameter. For more information, see In-Place eDiscovery.

EnableRoomMailboxAccount

Required

System.Boolean

Use the EnableRoomMailboxAccount parameter and the $true value to specify that the corresponding account in Active Directory for the new room mailbox is enabled when the mailbox is created. Both the Room and RoomMailboxPassword parameters are also required to create a logon-enabled room mailbox.

When you create a room mailbox using only the Room parameter, the account in Active Directory is logon-disabled, which prevents users from signing in to the mailbox. When you include the EnableRoomMailboxAccount and RoomMailboxPassword parameters, the account in Active Directory is logon-enabled, which is required for implementing some scenarios, such as the Lync Room System. In Exchange Online, a logon-enabled room mailbox doesn't require a license.

Equipment

Required

System.Management.Automation.SwitchParameter

The Equipment parameter specifies that the type of resource is equipment, if this mailbox is a resource mailbox. This parameter is required only if you're creating a resource mailbox.

FederatedIdentity

Required

System.String

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The FederatedIdentity parameter associates an on-premises Active Directory user with a Microsoft Office user.

ImportLiveId

Required

System.Management.Automation.SwitchParameter

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The ImportLiveId parameter imports an unmanaged Microsoft account (formerly known as a Windows Live ID) into the cloud-based domain. An unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service.

Importing a Microsoft account into the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts. However, the Microsoft account is now subject to the security and privacy policies of the organization.

LinkedDomainController

Required

System.String

The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides. The domain controller in this forest is used to get security information for the account specified by the LinkedMasterAccount parameter. This parameter is required only if you're creating a linked mailbox.

LinkedMasterAccount

Required

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides. The master account is the account to link the mailbox to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox.

This parameter accepts the following values:

• Alias
  
  Example: JPhillips
  
  
• Canonical DN
  
  Example: Atlanta.Corp.Contoso.Com/Users/JPhillips
  
  
• Display Name
  
  Example: Jeff Phillips
  
  
• Distinguished Name (DN)
  
  Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com
  
  
• Domain\Account
  
  Example: Atlanta\JPhillips
  
  
• GUID
  
  Example: fb456636-fe7d-4d58-9d15-5af57d0354c2
  
  
• Immutable ID
  
  Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com
  
  
• Legacy Exchange DN
  
  Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips
  
  
• SMTP Address
  
  Example: Jeff.Phillips@contoso.com
  
  
• User Principal Name
  
  Example: JPhillips@contoso.com
  
  

MicrosoftOnlineServicesID

Required

Microsoft.Exchange.Data.WindowsLiveId

The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

Name

Required

System.String

The Name parameter specifies the user's name. This is the name that appears in Active Directory Users and Computers.

Password

Required

System.Security.SecureString

The Password parameter specifies the initial password for the newly created user. This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the user account for these types of mailboxes is disabled.

PublicFolder

Required

System.Management.Automation.SwitchParameter

The PublicFolder parameter specifies that the new mailbox will be a public folder mailbox. Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. This parameter is required to create a public folder mailbox.

The first public folder mailbox created in your Exchange organization is called the primary hierarchy mailbox. It contains the writeable copy of the hierarchy of public folders for the organization and public folder content. There can be only one writeable copy of the public folder hierarchy in your organization. All other public folder mailboxes are called secondary public folder mailboxes and contain a read-only copy of the hierarchy and the content for public folders.

Room

Required

System.Management.Automation.SwitchParameter

The Room parameter specifies that the type of resource is a room, if this mailbox is a resource mailbox. This parameter is required only if you're creating a resource mailbox.

Shared

Required

System.Management.Automation.SwitchParameter

The Shared parameter specifies that you're creating a shared mailbox. A shared mailbox is a mailbox to which multiple users can log on. This mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account.

This parameter is required only if you're creating a shared mailbox.

UseExistingLiveId

Required

System.Management.Automation.SwitchParameter

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The UseExistingLiveId parameter uses the specified Microsoft account (formerly known as a Windows Live ID) that already exists in the cloud-based domain. The specified Microsoft account can't have a mailbox associated with it.

UserPrincipalName

Required

System.String

The UserPrincipalName parameter specifies the UPN for this mailbox. This is the logon name for the user. The UPN consists of a user name and a suffix. Typically, the suffix is the domain name where the user account resides.

WindowsLiveID

Required

Microsoft.Exchange.Data.WindowsLiveId

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The WindowsLiveID parameter specifies the Microsoft account (formerly known as a Windows Live ID) of the mailbox.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ActiveSyncMailboxPolicy parameter specifies the mailbox policy to enable for the mailbox that you create. If you don't specify this parameter, the default mailbox policy is used.

AddOnSKUCapability

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

AddressBookPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookMailboxPolicyIdParameter

The AddressBookPolicy parameter specifies the address book policy to apply to this mailbox. For more information about address book policies, see Address Book Policies.

Alias

Optional

System.String

The Alias parameter specifies the email alias of the user that you're creating.

The alias can be a combination of characters separated by a period with no intervening spaces. Don't use special characters in the alias.

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process.

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive parameter specifies whether to create an archive mailbox for the specified user.

You don't have to specify a value with this parameter.

ArchiveDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The ArchiveDatabase parameter specifies the Exchange database that contains the archive associated with this mailbox. You can use the following values:

• GUID of the database
  
  
• Database name
  
  

BypassLiveId

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

Database

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Database parameter specifies which Exchange database contains the new user's mailbox. You can use the following values:

• GUID of the database
  
  
• Database name
  
  

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name for the new user created with this mailbox. The value of the DisplayName parameter is the name that appears in the Exchange Administration Center. The value of the DisplayName parameter also appears in Active Directory Users and Computers on the user Properties General tab.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EvictLiveId

Optional

System.Management.Automation.SwitchParameter

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The EvictLiveId parameter specifies whether to remove an unmanaged Microsoft account (formerly known as a Windows Live ID) from the cloud-based domain. An unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service.

Evicting a Microsoft account from the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts.

ExternalDirectoryObjectId

Optional

System.String

This parameter is reserved for internal Microsoft use.

FirstName

Optional

System.String

The FirstName parameter specifies the first name of the user that you create.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter specifies whether to suppress warning or confirmation messages. This parameter can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force parameter isn't provided in the command, administrative input is prompted. If the Force parameter is provided in the command, but the value is omitted, its default value is $true.

HoldForMigration

Optional

System.Management.Automation.SwitchParameter

The HoldForMigration parameter prevents any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging into a public folder mailbox. Use this parameter when creating the first public folder mailbox in Exchange 2013 if you plan to migrate legacy public folders from Exchange 2010 or Exchange 2007 to Exchange 2013.

Warning:
Use this parameter only if you plan to migrate legacy public folders to Exchange 2013. If you use this parameter but don't have legacy public folders to migrate, you won't be able to create any public folders.

ImmutableId

Optional

System.String

The ImmutableId parameter is used by Outlook Live Directory Sync (OLSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox that's used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange will create the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account name space, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You must set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into off-premises mailboxes and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premise Exchange deployment scenario.

Initials

Optional

System.String

The Initials parameter specifies the initials of the user that you create.

IsExcludedFromServingHierarchy

Optional

System.Boolean

The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on the specified public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and won't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user will still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox.

LastName

Optional

System.String

The LastName parameter specifies the last name of the user that you create.

LinkedCredential

Optional

System.Management.Automation.PSCredential

The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox.

MailboxPlan

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The MailboxPlan parameter specifies the mailbox plan to associate with this mailbox. A mailbox plan specifies the permissions and features available to a mailbox user. The mailbox plan name you provide must be included in the service plan of the organization in which this mailbox resides.

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create.

ManagedFolderMailboxPolicyAllowed

Optional

System.Management.Automation.SwitchParameter

The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for email clients using versions of Microsoft Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies the users who are responsible for moderating the messages sent to this mailbox. To designate more than one user, separate the users with commas.

This parameter is required if you set the ModerationEnabled parameter to $true. If you leave this parameter blank and there's a user who's already specified as the manager of this mailbox, the ModeratedBy parameter is automatically set to the ManagedBy parameter of the mailbox. Otherwise, an error is returned.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the mailbox. The two possible values for this parameter are $true or $false. To enable moderation, set this parameter to $true. To disable moderation, set this parameter to $false.

The default value is $false.

NetID

Optional

Microsoft.Exchange.Data.NetID

This parameter is reserved for internal Microsoft use.

Office

Optional

System.String

The Office parameter specifies the Microsoft Office attribute for this mailbox.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter specifies the container where the user is created.

OverrideRecipientQuotas

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Phone

Optional

System.String

The Phone parameter specifies the user's telephone number for this mailbox.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address of the mailbox.

QueryBaseDNRestrictionEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RemoteAccountPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.RemoteAccountPolicyIdParameter

This parameter is reserved for internal Microsoft use.

RemoteArchive

Optional

System.Management.Automation.SwitchParameter

The RemoteArchive parameter specifies whether to disconnect the remote archive for this mailbox. A remote archive exists in a cloud-based service.

When you use this parameter, you can't use the Archive parameter.

RemotePowerShellEnabled

Optional

System.Boolean

The RemotePowerShellEnabled parameter specifies whether the user can use remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell or the Exchange Administration Center. Access to remote PowerShell is required even if you're trying to open the Shell or the EAC on the local server.

RemovedMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.RemovedMailboxIdParameter

This parameter is reserved for internal Microsoft use.

ResetPasswordOnNextLogon

Optional

System.Boolean

The ResetPasswordOnNextLogon parameter specifies whether the password in the Password parameter must be reset the next time the user logs on. If set to $true, the ResetPasswordOnNextLogon parameter specifies that the password in the Password parameter must be reset the next time the user logs on.

ResourceCapacity

Optional

System.Int32

The ResourceCapacity parameter specifies capacity, if this mailbox is a resource mailbox.

You must specify a non-negative integer.

RetentionPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The RetentionPolicy parameter specifies the name of a retention policy that you want applied to this mailbox. Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained.

RoleAssignmentPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The RoleAssignmentPolicy parameter specifies the management role assignment policy to assign to the mailbox when it's created or enabled. If you don't include this parameter when you create or enable a mailbox, the default assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see Understanding Management Role Assignment Policies.

RoomMailboxPassword

Optional

System.Security.SecureString

Use the RoomMailboxPassword parameter to specify a password when using the EnableRoomMailboxAccount parameter to create a logon-enabled room mailbox. Use the following syntax to specify the password: -RoomMailboxPassword (ConvertTo-SecureString -String <password> -AsPlainText -Force).

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 95, Windows 98, and LAN Manager. This attribute must be less than 20 characters to support older clients.

If you don't specify the SamAccountName parameter, Active Directory creates a SAMAccountName attribute automatically, based on the UPN.

SendModerationNotifications

Optional

Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags

The SendModerationNotifications parameter specifies whether status notifications are sent to users when they send a message to the moderated mailbox. You can specify one of the following values:

• Always
  
  
• Internal
  
  
• Never
  
  

If you want notifications to be sent to all senders, set this value to Always.

If you want notifications to be sent only to the senders who are internal to your organization, set this value to Internal.

To disable all status notifications, set this value to Never.

Note:
The sender is always notified if the message is rejected by the moderators, regardless of the value of this parameter. The default value is Never.

SharingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.SharingPolicyIdParameter

The SharingPolicy parameter specifies the identity of the sharing policy associated with this mailbox.

SKUAssigned

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

SKUCapability

Optional

Microsoft.Exchange.Data.Directory.Capability

This parameter is reserved for internal Microsoft use.

TargetAllMDBs

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ThrottlingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

The ThrottlingPolicy parameter specifies the identity of the throttling policy that you want to specify for this mailbox.

UsageLocation

Optional

Microsoft.Exchange.Data.Directory.CountryInfo

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.