[This topic is in progress.]

Applies to: Exchange Server 2010 SP2

Topic Last Modified: 2011-05-04

This cmdlet is available only for multi-tenant deployments.

Use the Get-MailboxPlan cmdlet to view information about mailbox plans in the organization.

Syntax


`Get-MailboxPlan [-Identity <MailboxPlanIdParameter>] [-AllMailboxPlanReleases <SwitchParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]`

Get-MailboxPlan [-Identity
<MailboxPlanIdParameter>] [-AllMailboxPlanReleases
<SwitchParameter>] [-Credential <PSCredential>]
[-DomainController <Fqdn>] [-Filter <String>]
[-IgnoreDefaultScope <SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-OrganizationalUnit
<OrganizationalUnitIdParameter>] [-ReadFromDomainController
<SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy
<String>]

Detailed Description

A mailbox plan is a template that automatically populates multiple user properties and assigns default permissions to new or existing user accounts.

To use or change the MailboxPlan parameter, tenant administrators must have the ChangeMailboxPlanAssignmentPermissions feature assigned through their service plan.

Parameters

Parameter	Required	Type	Description
AllMailboxPlanReleases	Optional	System.Management.Automation.SwitchParameter	The AllMailboxPlanReleases parameter displays all mailbox plans in the organization, including mailbox plans used in the previous version of the cloud-based service. If you don't specify the AllMailboxPlanReleases parameter, the Get-MailboxPlan cmdlet only displays mailbox plans used in the current version of the cloud-based service. This parameter only has meaning for organizations that were enrolled in the previous version of the cloud-based service.
Credential	Optional	System.Management.Automation.PSCredential	The Credential parameter specifies the user name and password for accessing the mailbox plan. The default is the current user's credentials. 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	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.
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.
Identity	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter	The Identity parameter specifies the mailbox plan. You can use any value that uniquely identifies the mailbox plan, for example: Distinguished name (DN) Display name GUID LegacyExchangeDN Name
IgnoreDefaultScope	Optional	System.Management.Automation.SwitchParameter	The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions: You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. You can't use the OrganizationalUnit and Identity parameters together. You can't use the Credential parameter.
Organization	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.
OrganizationalUnit	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter	This parameter is reserved for internal Microsoft use.
ReadFromDomainController	Optional	System.Management.Automation.SwitchParameter	This parameter is reserved for internal Microsoft use.
ResultSize	Optional	Microsoft.Exchange.Data.Unlimited	The ResultSize parameter specifies the total number of items to display.
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: Display name Name Alias The results are sorted in ascending order.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Errors

Error	Description

Examples

EXAMPLE 1

This example returns all mailbox plans in the organization.

	Copy Code
Get-MailboxPlan