Export (0) Print
Expand All

Set-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 Set-SiteMailboxProvisioningPolicy cmdlet to modify an existing site mailbox provisioning policy.

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

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

This example changes the site mailbox provisioning policy named Default to allow the maximum size of email messages that can be received by the site mailbox to 25 MB. When you install Exchange, a provisioning policy is created with the name Default.

Set-SiteMailboxProvisioningPolicy -Identity Default -MaxReceiveSize 25MB

This example changes the warning quota to 9.5 GB and the prohibit send and receive quota to 10 GB.

Set-SiteMailboxProvisioningPolicy -Identity Default -IssueWarningQuota 9GB -ProhibitSendReceiveQuota 10GB

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

NoteNote:
By default, the DefaultAliasPrefixEnabled parameter is set to $true and 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.
Set-SiteMailboxProvisioningPolicy -Identity SM_DefaultPolicy -AliasPrefix Project

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 mailbox provisioning policy" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The Identity parameter specifies the identity of the site mailbox provisioning policy that you want to edit.

AliasPrefix

Optional

System.String

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 will be used. If AliasPrefix parameter is set to $null and the DefaultAliasPrefixEnabled parameter is set to $false, no prefix will be used.

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.

DefaultAliasPrefixEnabled

Optional

System.Boolean

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 switch 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 gigabytes (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 1 B to 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 1 B to unlimited. If you enter a value of unlimited, no size limit is imposed on the site mailbox.

Name

Optional

System.String

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

The Name parameter allows you to change the name of the site mailbox provisioning policy.

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 1 B to 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