.png)
New-SiteMailboxProvisioningPolicy
Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-14
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-.
 Note: |
|---|
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 | The Name parameter specifies the name of the provisioning policy that you are creating. |
| 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 |
| 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 |
| 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 For example, if the DefaultAliasPrefixEnabled parameter is set to This parameter accepts |
| 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. |
| IgnoreDehydratedFlag | Optional | System.Management.Automation.SwitchParameter | This parameter is reserved for internal Microsoft use. |
| IsDefault | Optional | System.Management.Automation.SwitchParameter | 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 | 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:
Unqualified values are treated as bytes. The valid input range for this parameter is from |
| MaxReceiveSize | Optional | Microsoft.Exchange.Data.ByteQuantifiedSize | 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:
Unqualified values are treated as bytes. The valid input range for this parameter is from |
| Organization | Optional | Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter | The Organization parameter is reserved for internal Microsoft use. |
| ProhibitSendReceiveQuota | Optional | Microsoft.Exchange.Data.ByteQuantifiedSize | 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:
Unqualified values are treated as bytes. The valid input range for this parameter is from |
| 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.
