Commands › Exchange Online

Set-SiteMailboxProvisioningPolicy

Exchange Online ExchangeOnlineManagement Set-*

Modify an existing site mailbox provisioning policy. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

Quick start script

# Set-SiteMailboxProvisioningPolicy — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SiteMailboxProvisioningPolicy
$before | Format-List

# 3. Make the change (dry run first)
Set-SiteMailboxProvisioningPolicy -Identity <MailboxPolicyIdParameter> -WhatIf
Set-SiteMailboxProvisioningPolicy -Identity <MailboxPolicyIdParameter>

# 4. Verify and diff
$after = Get-SiteMailboxProvisioningPolicy
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-SiteMailboxProvisioningPolicy [-Identity] <MailboxPolicyIdParameter>
 [-AliasPrefix <String>]
 [-Confirm]
 [-DefaultAliasPrefixEnabled <Boolean>]
 [-DomainController <Fqdn>]
 [-IsDefault]
 [-IssueWarningQuota <ByteQuantifiedSize>]
 [-MaxReceiveSize <ByteQuantifiedSize>]
 [-Name <String>]
 [-ProhibitSendReceiveQuota <ByteQuantifiedSize>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (11)

Parameter	Type	Required	What it controls
-Identity	MailboxPolicyIdParameter	yes	The Identity parameter specifies the identity of the site mailbox provisioning policy that you want to edit. You can use any value that uniquely identifies the policy. For example:
-AliasPrefix	String		The AliasPrefix parameter specifies the custom text prefix to add to the aliases of new site mailboxes. Valid values are:
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DefaultAliasPrefixEnabled	Boolean		The DefaultAliasPrefixEnabled parameter specifies whether new site mailboxes have the default prefix text added to the alias. Valid values are:
-DomainController	Fqdn		The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-IsDefault	SwitchParameter		The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch.
-IssueWarningQuota	ByteQuantifiedSize		The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message.
-MaxReceiveSize	ByteQuantifiedSize		The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected.
-Name	String		The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
-ProhibitSendReceiveQuota	ByteQuantifiedSize		The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to...
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.