Export (0) Print
Expand All

New-SiteMailboxProvisioningPolicy

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-SiteMailboxProvisioningPolicy cmdlet to create a provisioning policy for site mailboxes that configures the send and receive quotas and allows you to set the default provisioning policy.

For information about the parameter sets in the Syntax section below, see Syntax.

New-SiteMailboxProvisioningPolicy -Name <String> [-AliasPrefix <String>] [-Confirm [<SwitchParameter>]] [-DefaultAliasPrefixEnabled <$true | $false>] [-DomainController <Fqdn>] [-IgnoreDehydratedFlag <SwitchParameter>] [-IsDefault <SwitchParameter>] [-IssueWarningQuota <ByteQuantifiedSize>] [-MaxReceiveSize <ByteQuantifiedSize>] [-Organization <OrganizationIdParameter>] [-ProhibitSendReceiveQuota <ByteQuantifiedSize>] [-WhatIf [<SwitchParameter>]]

This example creates the default provisioning policy SM_ProvisioningPolicy that has the following settings:

  • The warning quota for the site mailboxes is 9 GB.

  • The site mailboxes are prohibited from receiving messages when the mailbox size reaches 10 GB.

  • The maximum size of email messages that can be sent to site mailboxes is 50 MB.

New-SiteMailboxProvisioningPolicy -Name SM_ProvisioningPolicy -IsDefault -IssueWarningQuota 9GB -ProhibitSendReceiveQuota 10GB -MaxReceiveSize 50MB 

This example creates the default provisioning policy SM_DefaultPolicy that uses the defaults for send and receive quotas. If you don't explicitly specify the IssueWarningQuota and ProhibitSendReceiveQuota parameters, the command uses the default values.

New-SiteMailboxProvisioningPolicy -Name SM_DefaultPolicy -IsDefault

This example creates the default provisioning policy SM_DefaultPolicy and sets the AliasPrefix to Project. When site mailboxes are created, they are prepended with the prefix Project-.

NoteNote:
By default, the DefaultAliasPrefixEnabled parameter is set to $true, all on-premises site mailboxes are created with the prefix SM-, and all cloud-based site mailboxes are created with the prefix SMO-. The AliasPrefix parameter takes precedence over the DefaultAliasPrefixEnabled parameter.
New-SiteMailboxProvisioningPolicy -Name SM_DefaultPolicy -IsDefault -AliasPrefix Project

You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. When Exchange is installed, a site mailbox provisioning policy is created named Default. When creating a site mailbox provisioning policy, you can set the send and receive quotas. If you don't explicitly state the quotas, the cmdlet uses the default values. The following are the default values.

  • IssueWarningQuota   4.5 gigabytes (GB)

  • ProhibitSendReceiveQuota   5 GB

  • MaxReceiveSize   36 megabytes (MB)

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Site mailboxes" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Name

Required

System.String

This parameter is available only in on-premises Exchange 2013.

The Name parameter specifies the name of the provisioning policy that you are creating.

AliasPrefix

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The AliasPrefix parameter allows you to configure a custom prefix that you want added to site mailbox aliases. If the AliasPrefix parameter is set to a valid, non-null string, each new site mailbox will have that string prepended to the alias. If the AliasPrefix parameter is set to $null and the DefaultAliasPrefixEnabled parameter is set to $true, the default prefix is used. If the AliasPrefix parameter is set to $null and the DefaultAliasPrefixEnabled parameter is set to $false, no prefix is used.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DefaultAliasPrefixEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The DefaultAliasPrefixEnabled parameter specifies whether all new site mailboxes will have SM- prepended to the alias if the site mailbox is in an on-premises organization or will have SMO- prepended to the alias if the site mailbox is in an Exchange Online or Office365 organization. However, if a value has been specified for the AliasPrefix parameter, that value will be used even if this parameter is set to $true.

For example, if the DefaultAliasPrefixEnabled parameter is set to $true, the AliasPrefix parameter is set to $null, and an on-premises site mailbox is created named BugBash_2013, the alias for that site mailbox will be SM-BugBash_2013. If the AliasPrefix parameter is $null and the DefaultAliasPrefixEnabled parameter is $false, no prefix will be added for new site mailboxes.

This parameter accepts $true or $false. The default value is $true.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

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

IgnoreDehydratedFlag

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IsDefault

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The IsDefault parameter specifies that the site mailbox provisioning policy is the default policy. You can have multiple policies, but only the default policy is followed when users create site mailboxes.

IssueWarningQuota

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is available only in on-premises Exchange 2013.

The IssueWarningQuota parameter specifies the site mailbox size that triggers a warning message to the site mailbox. The default value is 4.5 GB.

When you enter the value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is available only in on-premises Exchange 2013.

The MaxReceiveSize parameter specifies the maximum size of email messages that can be received by the site mailbox. The default value is 36 MB.

When you enter the value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ProhibitSendReceiveQuota

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is available only in on-premises Exchange 2013.

The ProhibitSendReceiveQuota parameter specifies the size at which the site mailbox can no longer send or receive messages. The default value is 5 GB.

When you enter the value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is from 1B through unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft