ExchangePowerShell

Exchange PowerShell is built on Windows PowerShell technology and provides a powerful command-line interface that enables automation of administrative tasks. The following PowerShell environments are available in Exchange:

Note

For Exchange Online, Security & Compliance, and Exchange Online Protection, the module from the PowerShell Gallery that you use to connect is ExchangeOnlineManagement. For more information, see About the Exchange Online PowerShell module.

For Exchange Server, there is no Microsoft-provided module in the PowerShell Gallery. Instead, to use PowerShell in Exchange, you have the following options:

active-directory

Add-ADPermission

This cmdlet is available only in on-premises Exchange.

Use the Add-ADPermission cmdlet to add permissions to an Active Directory object.

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

Dump-ProvisioningCache

This cmdlet is available only in on-premises Exchange.

Use the Dump-ProvisioningCache cmdlet to return a list of the cached keys and values for the specified server and Windows PowerShell application.

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

Get-ADPermission

This cmdlet is available only in on-premises Exchange.

Use the Get-ADPermission cmdlet to get permissions on an Active Directory object.

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

Get-ADServerSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-AdServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007.

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

Get-ADSite

This cmdlet is available only in on-premises Exchange.

Use the Get-AdSite cmdlet to display configuration information about one or more Active Directory sites.

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

Get-AdSiteLink

This cmdlet is available only in on-premises Exchange.

Use the Get-AdSiteLink cmdlet to view configuration information about an Active Directory IP site link.

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

Get-DomainController

This cmdlet is available only in on-premises Exchange.

Use the Get-DomainController cmdlet to view a list of domain controllers that exist in your organization.

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

Get-OrganizationalUnit

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

Use the Get-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization.

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

Get-Trust

This cmdlet is available only in on-premises Exchange.

Use the Get-Trust cmdlet to return external and forest trusts.

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

Get-UserPrincipalNamesSuffix

This cmdlet is available only in on-premises Exchange.

Use the Get-UserPrincipalNamesSuffix cmdlet to view the user principal name (UPN) suffixes in the Active Directory forest. The UPN suffixes are created in Active Directory Domains and Trusts.

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

Remove-ADPermission

This cmdlet is available only in on-premises Exchange.

Use the Remove-ADPermission cmdlet to remove permissions from an Active Directory object.

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

Reset-ProvisioningCache

This cmdlet is available only in on-premises Exchange.

The Reset-ProvisioningCache cmdlet clears the Windows PowerShell provisioning cache of frequently used Active Directory objects. This cmdlet is only used for diagnostic purposes.

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

Set-ADServerSettings

This cmdlet is available only in on-premises Exchange.

Use the Set-AdServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007.

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

Set-ADSite

This cmdlet is available only in on-premises Exchange.

Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites.

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

Set-AdSiteLink

This cmdlet is available only in on-premises Exchange.

Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link.

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

antispam-antimalware

Add-AttachmentFilterEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers.

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

Add-ContentFilterPhrase

This cmdlet is available only in on-premises Exchange.

Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent. A custom word is a word or phrase that the administrator sets for the Content Filter agent to evaluate the content of an message and apply appropriate filter processing.

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

Add-IPAllowListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Add-IPAllowListEntry cmdlet to add IP Allow list entries to the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers.

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

Add-IPAllowListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Add-IPAllowListProvider cmdlet to create IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Add-IPBlockListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Add-IPBlockListEntry cmdlet to add IP Block list entries to the IP Block list that's used by the Connection Filtering agent on Edge Transport servers.

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

Add-IPBlockListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Add-IPBlockListProvider cmdlet to create IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Delete-QuarantineMessage

This cmdlet is available only in the cloud-based service.

Use the Delete-QuarantineMessage cmdlet to delete quarantine messages from your cloud-based organization

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

Disable-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Disable-EOPProtectionPolicyRule cmdlet to turn off the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Disable-ATPProtectionPolicyRule cmdlet to turn off the policy.

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

Disable-HostedContentFilterRule

This cmdlet is available only in the cloud-based service.

Use the Disable-HostedContentFilterRule cmdlet to disable spam filter rules (content filter rules) in your cloud-based organization.

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

Disable-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the Disable-HostedOutboundSpamFilterRule cmdlet to disable outbound spam filter rules in your cloud-based organization.

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

Disable-MalwareFilterRule

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

Use the Disable-MalwareFilterRule cmdlet to disable malware filter rules in your organization.

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

Disable-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the Disable-ReportSubmissionRule cmdlet to disable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

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

Enable-AntispamUpdates

The Enable-AntispamUpdates cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used.

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

Enable-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Enable-EOPProtectionPolicyRule cmdlet to turn on the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Enable-ATPProtectionPolicyRule cmdlet to turn on the policy.

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

Enable-HostedContentFilterRule

This cmdlet is available only in the cloud-based service.

Use the Enable-HostedContentFilterRule cmdlet to enable spam filter rules (content filter rules) in your cloud-based organization.

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

Enable-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the Enable-HostedOutboundSpamFilterRule cmdlet to enable outbound spam filter rules in your cloud-based organization.

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

Enable-MalwareFilterRule

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

Use the Enable-MalwareFilterRule cmdlet to enable malware filter rules in your organization.

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

Enable-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the Enable-ReportSubmissionRule cmdlet to enable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

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

Export-QuarantineMessage

This cmdlet is available only in the cloud-based service.

Use the Export-QuarantineMessage cmdlet to export quarantined messages and files from your cloud-based organization. Messages are exported to .eml message files so you can open them in Outlook.

For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the files are exported in Base64 format.

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

Get-AgentLog

This cmdlet is available only in on-premises Exchange.

Use the Get-AgentLog cmdlet to parse log files that you specify as parameters and collect raw statistics from the filtering that anti-spam agents apply during a time period that you specify.

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

Get-AggregateZapReport

This cmdlet is available only in the cloud-based service.

Use the Get-AggregateZapReport cmdlet to view aggregate information about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days.

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

Get-ArcConfig

This cmdlet is available only in the cloud-based service.

Use the Get-ArcConfig cmdlet to view the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization.

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

Get-AttachmentFilterEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-AttachmentFilterEntry cmdlet to view the list of attachment filter entries that are used by the Attachment Filtering agent on Edge Transport servers.

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

Get-AttachmentFilterListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-AttachmentFilterListConfig cmdlet to view the configuration of the Attachment Filtering agent on Edge Transport servers.

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

Get-BlockedConnector

This cmdlet is available only in the cloud-based service.

Use the Get-BlockedConnector cmdlet to view inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email.

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

Get-BlockedSenderAddress

This cmdlet is available only in the cloud-based service.

Use the Get-BlockedSenderAddress cmdlet to view users in your Microsoft 365 organization that are impacted by the protection system. These users sent multiple messages that were classified as spam, so they're blocked from sending messages.

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

Get-ConfigAnalyzerPolicyRecommendation

This cmdlet is available only in the cloud-based service.

Use the Get-ConfigAnalyzerPolicyRecommendation cmdlet to compare the settings in your existing security policies to the settings that are used in the Standard or Strict preset security policies. Settings that are below the recommend value are returned in the results.

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

Get-ContentFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-ContentFilterConfig cmdlet to view the content filter configuration for the computer on which the cmdlet is run.

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

Get-ContentFilterPhrase

This cmdlet is available only in on-premises Exchange.

Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes.

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

Get-DetailZapReport

This cmdlet is available only in the cloud-based service.

Use the Get-DetailZapReport cmdlet to view details about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days.

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

Get-DkimSigningConfig

This cmdlet is available only in the cloud-based service.

Use the Get-DkimSigningConfig cmdlet to view the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization.

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

Get-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Get-EOPProtectionPolicyRule cmdlet to view rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

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

Get-ExoPhishSimOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Get-ExoPhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Get-ExoSecOpsOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Get-HostedConnectionFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-HostedConnectionFilterPolicy cmdlet to view the settings of connection filter policies in your cloud-based organization.

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

Get-HostedContentFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-HostedContentFilterPolicy cmdlet to view the settings of spam filter policies (content filter policies) in your cloud-based organization.

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

Get-HostedContentFilterRule

This cmdlet is functional only in the cloud-based service.

Use the Get-HostedContentFilterRule cmdlet to view spam filter rules (content filter rules) in your cloud-based organization.

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

Get-HostedOutboundSpamFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-HostedOutboundSpamFilterPolicy cmdlet to view outbound spam filter policies in your cloud-based organization.

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

Get-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the Get-HostedOutboundSpamFilterRule cmdlet to view outbound spam filter rules in your cloud-based organization.

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

Get-IPAllowListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPAllowListConfig cmdlet to view the configuration information for the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPAllowListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPAllowListEntry cmdlet to view the IP address entries in the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPAllowListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPAllowListProvider cmdlet to view IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPAllowListProvidersConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPAllowListProvidersConfig cmdlet to view the settings that affect all IP Allow list providers that are configured on an Edge Transport server.

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

Get-IPBlockListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPBlockListConfig cmdlet to view the IP Block list configuration information that's used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPBlockListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPBlockListEntry cmdlet to view the IP Block list entries that are used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPBlockListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPBlockListProvider cmdlet to view IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Get-IPBlockListProvidersConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-IPBlockListProvidersConfig cmdlet to view the settings that affect all IP Block list providers that are configured on an Edge Transport server.

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

Get-MailboxJunkEmailConfiguration

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

Use the Get-MailboxJunkEmailConfiguration cmdlet to view the junk email settings on mailboxes.

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

Get-MalwareFilteringServer

This cmdlet is available only in on-premises Exchange.

Use the Get-MalwareFilteringServer cmdlet to view the Malware agent settings in the Transport service on a Mailbox server.

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

Get-MalwareFilterPolicy

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

Use the Get-MalwareFilterPolicy cmdlet to view the malware filter policies in your organization.

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

Get-MalwareFilterRule

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

Use the Enable-MalwareFilterRule cmdlet to view malware filter rules in your organization.

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

Get-PhishSimOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Get-PhishSimOverridePolicy cmdlet to view third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Get-QuarantineMessage

This cmdlet is available only in the cloud-based service.

Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. Files are quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.

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

Get-QuarantineMessageHeader

This cmdlet is available only in the cloud-based service.

Use the Get-QuarantineMessageHeader cmdlet to view the message header of a quarantined message. The command will fail if the specified message is not in quarantine.

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

Get-QuarantinePolicy

This cmdlet is available only in the cloud-based service.

Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization.

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

Get-RecipientFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-RecipientFilterConfig cmdlet to view the recipient filter configuration information for the Exchange server.

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

Get-ReportSubmissionPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-ReportSubmissionPolicy cmdlet to view the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization.

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

Get-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the Get-ReportSubmissionRule cmdlet to view the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

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

Get-SecOpsOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Get-SecOpsOverridePolicy cmdlet to view SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Get-SenderFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-SenderFilterConfig cmdlet to view the Sender Filter configuration information for the Exchange server.

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

Get-SenderIdConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-SenderIdConfig cmdlet to view the Sender ID configuration information for the Exchange server.

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

Get-SenderReputationConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-SenderReputationConfig cmdlet to view the configuration information for sender reputation on the computer on which the command is run.

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

Get-TeamsProtectionPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-TeamsProtectionPolicy cmdlet to view Microsoft Teams protection policies.

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

Get-TeamsProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Get-TeamsProtectionPolicyRule cmdlet to view Microsoft Teams protection policy rules.

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

Get-TenantAllowBlockListItems

This cmdlet is available only in the cloud-based service.

Use the Get-TenantAllowBlockListItems cmdlet to view entries in the Tenant Allow/Block List in the Microsoft Defender portal.

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

Get-TenantAllowBlockListSpoofItems

This cmdlet is available only in the cloud-based service.

Use the Get-TenantAllowBlockListSpoofItems cmdlet to view spoofed sender entries in the Tenant Allow/Block List.

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

New-DkimSigningConfig

This cmdlet is available only in the cloud-based service.

Use the New-DkimSigningConfig cmdlet to create the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization.

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

New-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the New-EOPProtectionPolicyRule cmdlet to create rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

Note: Unless you manually removed a rule using the Remove-EOPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them.

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

New-ExoPhishSimOverrideRule

This cmdlet is available only in the cloud-based service.

Use the New-ExoPhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

New-ExoSecOpsOverrideRule

This cmdlet is available only in the cloud-based service.

Use the New-ExoSecOpsOverrideRule cmdlet to create SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

New-HostedContentFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the New-HostedContentFilterPolicy cmdlet to create spam filter policies (content filter policies) in your cloud-based organization.

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

New-HostedContentFilterRule

This cmdlet is available only in the cloud-based service.

Use the New-HostedContentFilterRule cmdlet to create spam filter rules (content filter rules) in your cloud-based organization.

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

New-HostedOutboundSpamFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the New-HostedOutboundSpamFilterPolicy cmdlet to create outbound spam filter policies in your cloud-based organization.

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

New-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the New-HostedOutboundSpamFilterRule cmdlet to create outbound spam filter rules in your cloud-based organization.

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

New-MalwareFilterPolicy

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

Use the New-MalwareFilterPolicy cmdlet to create malware filter policies in your organization.

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

New-MalwareFilterRule

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

Use the New-MalwareFilterRule cmdlet to create malware filter rules in your organization.

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

New-PhishSimOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the New-PhishSimOverridePolicy cmdlet to create third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

New-QuarantinePermissions

This cmdlet is available only in the cloud-based service.

Note: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets.

Use the New-QuarantinePermissions cmdlet to create a variable that contains a quarantine permissions object to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session.

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

New-QuarantinePolicy

This cmdlet is available only in the cloud-based service.

Use the New-QuarantinePolicy cmdlet to create quarantine policies in your cloud-based organization.

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

New-ReportSubmissionPolicy

This cmdlet is available only in the cloud-based service.

Use the New-ReportSubmissionPolicy cmdlet to create the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization.

Note: If the policy already exists (the Get-ReportSubmissionPolicy cmdlet returns output), you can't use this cmdlet. To delete the existing policy and start over with the default settings, use the Remove-ReportSubmissionPolicy cmdlet first.

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

New-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the New-ReportSubmissionRule cmdlet to create the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

Note: If the rule already exists (the Get-ReportSubmissionRule cmdlet returns output), you can't use this cmdlet. To delete the existing rule and start over, use the Remove-ReportSubmissionRule cmdlet first.

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

New-SecOpsOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the New-SecOpsOverridePolicy cmdlet to create SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

New-TeamsProtectionPolicy

This cmdlet is available only in the cloud-based service.

Use the New-TeamsProtectionPolicy cmdlet to create Microsoft Teams protection policies.

Note: If the policy already exists (the Get-TeamsProtectionPolicy cmdlet returns output), you can't use this cmdlet.

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

New-TeamsProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the New-TeamsProtectionPolicyRule cmdlet to create Microsoft Teams protection policy rules.

Note: If the rule already exists (the Get-TeamsProtectionPolicyRule cmdlet returns output), you can't use this cmdlet.

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

New-TenantAllowBlockListItems

This cmdlet is available only in the cloud-based service.

Use the New-TenantAllowBlockListItems cmdlet to add entries to the Tenant Allow/Block List in the Microsoft Defender portal.

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

New-TenantAllowBlockListSpoofItems

This cmdlet is available only in the cloud-based service.

Use the New-TenantAllowBlockListSpoofItems cmdlet to create spoofed sender entries in the Tenant Allow/Block List.

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

Preview-QuarantineMessage

This cmdlet is available only in the cloud-based service.

Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. This cmdlet doesn't work on files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.

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

Release-QuarantineMessage

This cmdlet is available only in the cloud-based service.

Use the Release-QuarantineMessage cmdlet to release messages from quarantine in your cloud-based organization. You can release messages to all original recipients, or to specific recipients.

For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files.

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

Remove-AttachmentFilterEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-AttachmentFilterEntry cmdlet to remove an entry from the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers.

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

Remove-BlockedConnector

This cmdlet is available only in the cloud-based service.

Use the Remove-BlockedConnector cmdlet to unblock inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email.

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

Remove-BlockedSenderAddress

This cmdlet is available only in the cloud-based service.

Use the Remove-BlockedSenderAddress cmdlet to unblock users in your Microsoft 365 organization that were impacted by the protection system. These users sent multiple messages that were classified as spam, so they were blocked from sending messages.

Note: There's a limit to the number of times you can unblock a Microsoft 365 account. If you exceed the unblock limit for a user, you'll receive an error, and you'll need to contact support to unblock the user.

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

Remove-ContentFilterPhrase

This cmdlet is available only in on-premises Exchange.

Use the Remove-ContentFilterPhrase cmdlet to remove one or all custom words that the Content Filter agent processes.

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

Remove-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules from Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

Note: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-EOPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule.

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

Remove-ExoPhishSimOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Remove-ExoPhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Remove-ExoSecOpsOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Remove-ExoSecOpsOverrideRule cmdlet to remove SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Remove-HostedContentFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-HostedContentFilterPolicy cmdlet to remove spam filter policies (content filter policies) from your cloud-based organization.

When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedContentFilterRule cmdlet.

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

Remove-HostedContentFilterRule

This cmdlet is available only in the cloud-based service.

Use the Remove-HostedContentFilterRule cmdlet to remove spam filter rules (content filter rules) in your cloud-based organization.

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

Remove-HostedOutboundSpamFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-HostedOutboundSpamFilterPolicy cmdlet to remove outbound spam filter policies from your cloud-based organization.

When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedOutboundSpamFilterRule cmdlet.

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

Remove-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the Remove-HostedOutboundSpamFilterRule cmdlet to remove outbound spam filter rules in your cloud-based organization.

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

Remove-IPAllowListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-IPAllowListEntry cmdlet to remove IP address entries from the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers.

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

Remove-IPAllowListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-IPAllowListProvider cmdlet to remove IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Remove-IPBlockListEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-IPBlockListEntry cmdlet to remove IP block list entries that are used by the Connection Filtering agent on Edge Transport servers.

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

Remove-IPBlockListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-IPBlockListProvider cmdlet to remove IP Block list providers that are used by the Connection Filtering agent on Edge Transport server.

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

Remove-MalwareFilterPolicy

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

Use the Remove-MalwareFilterPolicy cmdlet to remove malware filter policies from your organization.

When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-MalwareFilterRule cmdlet.

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

Remove-MalwareFilterRule

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

Use the Remove-MalwareFilterRule cmdlet to remove malware filter rules from your organization.

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

Remove-PhishSimOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-PhishSimOverridePolicy cmdlet to remove third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Remove-QuarantinePolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-QuarantinePolicy cmdlet to remove quarantine policies from your cloud-based organization.

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

Remove-ReportSubmissionPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-ReportSubmissionPolicy cmdlet to remove the report submission policy from your cloud-based organization.

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

Remove-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the Remove-ReportSubmissionRule cmdlet to remove the report submission rule from your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

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

Remove-SecOpsOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-SecOpsOverridePolicy cmdlet to remove SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Remove-TenantAllowBlockListItems

This cmdlet is available only in the cloud-based service.

Use the Remove-TenantAllowBlockListItems cmdlet to remove entries from the Tenant Allow/Block List in the Microsoft Defender portal.

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

Remove-TenantAllowBlockListSpoofItems

This cmdlet is available only in the cloud-based service.

Use the Remove-TenantAllowBlockListSpoofItems cmdlet to remove spoofed sender entries from the Tenant Allow/Block List.

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

Rotate-DkimSigningConfig

This cmdlet is available only in the cloud-based service.

Use the Rotate-DkimSigningConfig cmdlet to rotate the public and private DomainKeys Identified Mail (DKIM) signing policy keys for domains in a cloud-based organization. This cmdlet creates new DKIM keys and uses the alternate DKIM selector.

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

Set-ArcConfig

This cmdlet is available only in the cloud-based service.

Use the Set-ArcConfig cmdlet to modify the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization.

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

Set-AttachmentFilterListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-AttachmentFilterListConfig cmdlet to modify the configuration of the Attachment Filtering agent on Edge Transport servers.

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

Set-ContentFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-ContentFilterConfig cmdlet to modify the content filter configuration on a Mailbox server or an Edge Transport server.

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

Set-DkimSigningConfig

This cmdlet is available only in the cloud-based service.

Use the Set-DkimSigningConfig cmdlet to modify the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization.

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

Set-EOPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Set-EOPProtectionPolicyRule cmdlet to modify rules that are associated with Exchange Online Protection (EOP) protections in preset security policies.

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

Set-ExoPhishSimOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Set-ExoPhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Set-HostedConnectionFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-HostedConnectionFilterPolicy cmdlet to modify the settings of connection filter policies in your cloud-based organization.

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

Set-HostedContentFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-HostedContentFilterPolicy cmdlet to modify spam filter policies (content filter policies) in your cloud-based organization.

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

Set-HostedContentFilterRule

This cmdlet is available only in the cloud-based service.

Use the Set-HostedContentFilterRule cmdlet to modify spam filter rules (content filter rules) in your cloud-based organization.

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

Set-HostedOutboundSpamFilterPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-HostedOutboundSpamFilterPolicy cmdlet to modify outbound spam filter policies in your cloud-based organization.

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

Set-HostedOutboundSpamFilterRule

This cmdlet is available only in the cloud-based service.

Use the Set-HostedOutboundSpamFilterRule cmdlet to modify the settings of outbound spam filter rules in your cloud-based organization.

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

Set-IPAllowListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPAllowListConfig cmdlet to modify the IP Allow list configuration that's used by the Connection Filtering agent on Edge Transport servers.

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

Set-IPAllowListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPAllowListProvider cmdlet to modify IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Set-IPAllowListProvidersConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPAllowListProvidersConfig cmdlet to modify the settings that affect all IP Allow list providers that are configured on an Edge Transport server.

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

Set-IPBlockListConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPBlockListConfig cmdlet to modify the IP Block list configuration that's used by the Connection Filtering agent on Edge Transport servers.

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

Set-IPBlockListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPBlockListProvider cmdlet to modify IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

Set-IPBlockListProvidersConfig

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-IPBlockListProvidersConfig cmdlet to modify the settings that affect all IP Block list providers that are configured on an Edge Transport server.

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

Set-MailboxJunkEmailConfiguration

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

Use the Set-MailboxJunkEmailConfiguration cmdlet to configure the junk email settings on mailboxes.

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

Set-MalwareFilteringServer

This cmdlet is available only in on-premises Exchange.

Use the Set-MalwareFilteringServer cmdlet to configure the Malware agent settings in the Transport service on a Mailbox server.

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

Set-MalwareFilterPolicy

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

Use the Set-MalwareFilterPolicy cmdlet to modify malware filter policies in your organization.

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

Set-MalwareFilterRule

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

Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization.

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

Set-PhishSimOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Set-PhishSimOverridePolicy cmdlet to modify third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Set-QuarantinePermissions

This cmdlet is available only in the cloud-based service.

Note: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets.

Use the Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that were created by the New-QuarantinePermissions and stored as a variable in the current PowerShell session. You use the variable as a value for the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session.

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

Set-QuarantinePolicy

This cmdlet is available only in the cloud-based service.

Use the Set-QuarantinePolicy cmdlet to modify quarantine policies in your cloud-based organization.

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

Set-RecipientFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-RecipientFilterConfig cmdlet to enable and configure the Recipient Filter agent.

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

Set-ReportSubmissionPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-ReportSubmissionPolicy cmdlet to modify the report submission policy in your cloud-based organization.

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

Set-ReportSubmissionRule

This cmdlet is available only in the cloud-based service.

Use the Set-ReportSubmissionRule cmdlet to modify the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.

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

Set-SecOpsOverridePolicy

This cmdlet is available only in the cloud-based service.

Use the Set-SecOpsOverridePolicy cmdlet to modify SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

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

Set-SenderFilterConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-SenderFilterConfig cmdlet to modify the Sender Filter agent configuration.

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

Set-SenderIdConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-SenderIdConfig cmdlet to modify the configuration of the Sender ID agent.

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

Set-SenderReputationConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-SenderReputationConfig cmdlet to modify the sender reputation configuration on Mailbox servers or Edge Transport servers.

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

Set-TeamsProtectionPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-TeamsProtectionPolicy cmdlet to modify Microsoft Teams protection policies.

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

Set-TeamsProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Set-TeamsProtectionPolicyRule cmdlet to modify Microsoft Teams protection policy rules.

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

Set-TenantAllowBlockListItems

This cmdlet is available only in the cloud-based service.

Use the Set-TenantAllowBlockListItems cmdlet to modify entries in the Tenant Allow/Block List in the Microsoft Defender portal.

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

Set-TenantAllowBlockListSpoofItems

This cmdlet is available only in the cloud-based service.

Use the Set-TenantAllowBlockListSpoofItems cmdlet to modify spoofed sender entries in the Tenant Allow/Block List.

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

Test-IPAllowListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Test-IPAllowListProvider cmdlet to test IP Allow list providers on Edge Transport servers.

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

Test-IPBlockListProvider

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Test-IPBlockListProvider cmdlet to test IP Block list providers on Edge Transport servers.

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

Test-SenderId

This cmdlet is available only in on-premises Exchange.

Use the Test-SenderId cmdlet to test whether a specified IP address is the legitimate sending address for a specified SMTP address.

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

Update-SafeList

This cmdlet is available only in on-premises Exchange.

Use the Update-SafeList cmdlet to update the safelist aggregation data in Active Directory. Safelist aggregation data is used in the built-in anti-spam filtering in Microsoft Exchange. EdgeSync replicates safelist aggregation data to Edge Transport servers in the perimeter network.

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

client-access

Clear-TextMessagingAccount

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

The Clear-TextMessagingAccount cmdlet allows a user to remove the text messaging settings from their own mailbox. An administrator can't use this cmdlet to remove the text messaging settings from another user's mailbox.

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

Compare-TextMessagingVerificationCode

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

Use the Compare-TextMessagingVerificationCode cmdlet to verify the text messaging verification code that the user specified as part of configuring text message notifications on the mailbox.

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

Disable-PushNotificationProxy

This cmdlet is available only in on-premises Exchange.

Use the Disable-PushNotificationProxy cmdlet to disable the push notification proxy that's configured between an on-premises Microsoft Exchange organization and a Microsoft 365 organization.

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

Enable-PushNotificationProxy

This cmdlet is available only in on-premises Exchange.

Use the Enable-PushNotificationProxy cmdlet to enable a push notification proxy between an on-premises Microsoft Exchange organization and a Microsoft 365 organization.

In order for event notifications to be successfully delivered, you also need to configure OAuth authentication between your on-premises Exchange organization and your Microsoft 365 organization.

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

Export-AutoDiscoverConfig

This cmdlet is available only in on-premises Exchange.

Use the Export-AutoDiscoverConfig cmdlet to create or update a service connection point for an Autodiscover service pointer in a target Exchange forest.

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

Get-CASMailbox

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

Use the Get-CASMailbox cmdlet to view the Client Access settings that are configured on mailboxes.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOCASMailbox cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

Get-CASMailboxPlan

This cmdlet is functional only in the cloud-based service.

Use the Get-CASMailboxPlan cmdlet to view Client Access services (CAS) mailbox plans in cloud-based organizations.

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

Get-ClientAccessRule

Note

Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see Update on Client Access Rules Deprecation in Exchange Online.

This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection.

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

Get-ImapSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-ImapSettings cmdlet to view the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This is the client access (frontend) IMAP4 service that clients connect to.

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

Get-MailboxCalendarConfiguration

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

Use the Get-MailboxCalendarConfiguration cmdlet to show the calendar settings for a specified mailbox.

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

Get-MailboxMessageConfiguration

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

Use the Get-MailboxMessageConfiguration cmdlet to view the Outlook on the web settings that are applied to specific mailboxes.

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

Get-MailboxRegionalConfiguration

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

Use the Get-MailboxRegionalConfiguration cmdlet to view the regional settings of a mailbox. You can view the date format, time format, time zone, and language of the mailbox.

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

Get-MailboxSpellingConfiguration

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

Use the Get-MailboxSpellingConfiguration cmdlet to retrieve the Outlook on the web spelling checker settings of a specified user. For example, users can set their dictionary language and configure the spelling checker to ignore mixed digits and words in all uppercase.

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

Get-OutlookProvider

This cmdlet is available only in on-premises Exchange.

Use the Get-OutlookProvider cmdlet to obtain the global settings from the AutoDiscoverConfig object under the Global Settings object in Active Directory.

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

Get-OwaMailboxPolicy

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

Use the Get-OwaMailboxPolicy cmdlet to view Outlook on the web mailbox policies in the organization.

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

Get-PopSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-POPSettings cmdlet to view the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed and is used by POP3 clients to connect to Exchange.

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

Get-TextMessagingAccount

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

Use the Get-TextMessagingAccount cmdlet to view the text notification settings on mailboxes.

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

New-ClientAccessRule

Note

Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see Update on Client Access Rules Deprecation in Exchange Online.

This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection.

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

New-OutlookProvider

This cmdlet is available only in on-premises Exchange.

Use the New-OutlookProvider cmdlet to create the AutoDiscoverConfig object and then populate the object with relevant settings.

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

New-OwaMailboxPolicy

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

Use the New-OwaMailboxPolicy cmdlet to create Outlook on the web mailbox policies.

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

Remove-ClientAccessRule

Note

Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see Update on Client Access Rules Deprecation in Exchange Online.

This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection.

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

Remove-OutlookProvider

This cmdlet is available only in on-premises Exchange.

Use the Remove-OutlookProvider cmdlet to delete the AutoDiscoverConfig object from Active Directory.

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

Remove-OwaMailboxPolicy

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

Use the Remove-OwaMailboxPolicy cmdlet to remove Outlook on the web mailbox policies from the organization.

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

Send-TextMessagingVerificationCode

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

Use the Send-TextMessagingVerificationCode cmdlet to send a text messaging verification as part of configuring text message notifications on the mailbox.

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

Set-CASMailbox

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

Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4.

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

Set-CASMailboxPlan

This cmdlet is available only in the cloud-based service.

Use the Set-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in cloud-based organizations.

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

Set-ClientAccessRule

Note

Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see Update on Client Access Rules Deprecation in Exchange Online.

This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection.

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

Set-ImapSettings

This cmdlet is available only in on-premises Exchange.

Use the Set-ImapSettings cmdlet to modify the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This service exists on Exchange servers that have the Client Access server role installed, and is used by IMAP4 clients to connect to Exchange.

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

Set-MailboxCalendarConfiguration

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

Use the Set-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user.

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

Set-MailboxMessageConfiguration

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

Use the Set-MailboxMessageConfiguration cmdlet to configure the Outlook on the web settings that are applied to specific mailboxes.

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

Set-MailboxRegionalConfiguration

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

Use the Set-MailboxRegionalConfiguration cmdlet to modify the regional settings of a mailbox. You can modify the date format, time format, time zone and language of the mailbox.

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

Set-MailboxSpellingConfiguration

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

Use the Set-MailboxSpellingConfiguration cmdlet to modify Outlook on the web spelling checker options for a specified user. For example, you can set the dictionary language and configure the spelling checker to ignore mixed digits or words in all uppercase.

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

Set-OutlookProvider

This cmdlet is available only in on-premises Exchange.

Use the Set-OutlookProvider cmdlet to set specific global settings using the msExchOutlookProvider attribute on the msExchAutoDiscoverConfig object in Active Directory.

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

Set-OwaMailboxPolicy

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

Use the Set-OwaMailboxPolicy cmdlet to configure existing Outlook on the web mailbox policies.

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

Set-PopSettings

This cmdlet is available only in on-premises Exchange.

Use the Set-PopSettings cmdlet to modify the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed, and is used by POP3 clients to connect to Exchange.

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

Set-TextMessagingAccount

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

The Set-TextMessagingAccount cmdlet allows a user to configure the text messaging settings on their own mailbox. An administrator can't use this cmdlet to configure the text messaging settings on another user's mailbox.

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

Test-CalendarConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-CalendarConnectivity cmdlet to verify that anonymous calendar sharing is enabled and working properly. The Calendar virtual directory is a subdirectory of the Microsoft Outlook on the web virtual directories. When you run this command without any parameters, the command tests calendar connectivity against all Outlook on the web virtual directories.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

Test-ClientAccessRule

Note

Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see Update on Client Access Rules Deprecation in Exchange Online.

This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results.

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

Test-EcpConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-EcpConnectivity cmdlet to test connectivity to Exchange Control Panel (ECP) virtual directories.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

Test-ImapConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-ImapConnectivity cmdlet to verify that connectivity to the Microsoft Exchange IMAP4 service is working as expected.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

Test-OutlookConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange organization. This includes testing for both Outlook Anywhere (RPC over HTTP) and MAPI over HTTP connections.

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

Test-OutlookWebServices

This cmdlet is functional only in Exchange Server 2010.

Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed.

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

Test-OwaConnectivity

This cmdlet is available only in Exchange Server 2010.

Use the Test-OwaConnectivity cmdlet to verify that Microsoft Office Outlook Web App is running as expected. The Test-OwaConnectivity cmdlet can be used to test Outlook Web App connectivity for all Microsoft Exchange Server 2010 virtual directories on a specified Client Access server for all mailboxes on servers running Exchange that are in the same Active Directory site. The Test-OwaConnectivity cmdlet can also be used to test the connectivity for an individual Exchange Outlook Web App URL.

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

Test-PopConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-PopConnectivity cmdlet to verify that the Microsoft Exchange POP3 service is working as expected.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

Test-PowerShellConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-PowerShellConnectivity cmdlet to test client connectivity to Exchange remote PowerShell virtual directories.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

Test-WebServicesConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-WebServicesConnectivity cmdlet to test client connectivity to Exchange Web Services virtual directories.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

client-access-servers

Disable-OutlookAnywhere

This cmdlet is available only in Exchange Server 2010.

Use the Disable-OutlookAnywhere cmdlet to disable Outlook Anywhere on Exchange Server 2010 Client Access servers.

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

Enable-OutlookAnywhere

This cmdlet is available only in Exchange Server 2010.

Use the Enable-OutlookAnywhere cmdlet to enable Outlook Anywhere on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. Running the Enable-OutlookAnywhere cmdlet enables the server to accept requests from Microsoft Office Outlook 2007 and Outlook 2003 client computers from the Internet by using Outlook Anywhere, also known as RPC over HTTP.

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

Get-ActiveSyncVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-ActiveSyncVirtualDirectory cmdlet to view Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-AuthRedirect

This cmdlet is available only in on-premises Exchange.

Use the Get-AuthRedirect cmdlet to view OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization.

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

Get-AutodiscoverVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-AutodiscoverVirtualDirectory cmdlet to view Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-ClientAccessArray

This cmdlet is available only in on-premises Exchange.

Use the Get-ClientAccessArray cmdlet to view legacy RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site) that exist in your Exchange organization.

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

Get-ClientAccessServer

This cmdlet is available only in on-premises Exchange.

Use the Get-ClientAccessServer cmdlet to view settings that are associated with the Client Access server role.

Note: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService.

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

Get-ClientAccessService

This cmdlet is available only in on-premises Exchange.

Use the Get-ClientAccessService cmdlet to view settings that are associated with the Client Access server role.

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

Get-EcpVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-EcpVirtualDirectory cmdlet to view Exchange Control Panel (ECP) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The Exchange admin center (EAC) uses the ECP virtual directories.

The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers.

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

Get-MapiVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-MapiVirtualDirectory cmdlet to view Message Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol.

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

Get-OutlookAnywhere

This cmdlet is available only in on-premises Exchange.

Use the Get-OutlookAnywhere cmdlet to view Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-OwaVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-OwaVirtualDirectory cmdlet to view Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-PowerShellVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-PowerShellVirtualDirectory cmdlet to view Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-RpcClientAccess

This cmdlet is available only in on-premises Exchange.

Use the Get-RpcClientAccess cmdlet to view the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP).

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

Get-WebServicesVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-WebServicesVirtualDirectory cmdlet to view Exchange Web Services (EWS) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

New-ActiveSyncVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-ActiveSyncVirtualDirectory cmdlet to create Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

New-AuthRedirect

This cmdlet is available only in on-premises Exchange.

Use the New-AuthRedirect cmdlet to create OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization.

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

New-AutodiscoverVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-AutodiscoverVirtualDirectory cmdlet to create Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

New-ClientAccessArray

This cmdlet is available only in Exchange Server 2010.

Use the New-ClientAccessArray cmdlet to create an object that represents a load balanced array of Client Access servers within a single Active Directory site.

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

New-EcpVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-EcpVirtualDirectory cmdlet to create Exchange Control Panel (ECP) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. This is a command that Microsoft Exchange Server Setup runs when you install Exchange in your organization. The ECP virtual directory manages the Exchange admin center.

The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers.

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

New-MapiVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-MapiVirtualDirectory cmdlet to create Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol.

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

New-OwaVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-OwaVirtualDirectory cmdlet to create Outlook on the web virtual directories that are used in Internet Information Services on Exchange servers. Typically, you create virtual directories on Exchange servers that have the Client Access server role installed.

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

New-PowerShellVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-PowerShellVirtualDirectory cmdlet to create Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

New-RpcClientAccess

This cmdlet is available only in Exchange Server 2010.

Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This set up task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010.

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

New-WebServicesVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-WebServicesVirtualDirectory cmdlet to create Exchange Web Services virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

You can create multiple virtual directories by using this cmdlet. However, you can create only one Exchange Web Services virtual directory for each website.

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

Remove-ActiveSyncVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-ActiveSyncVirtualDirectory cmdlet to remove existing Exchange ActiveSync virtual directories from Internet Information Services (IIS) virtual directories on Exchange servers.

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

Remove-AuthRedirect

This cmdlet is available only in on-premises Exchange.

Use the Remove-AuthRedirect cmdlet to remove OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization.

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

Remove-AutodiscoverVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-AutodiscoverVirtualDirectory cmdlet to remove an existing Autodiscover virtual directory from Internet Information Services (IIS).

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

Remove-ClientAccessArray

This cmdlet is available only in Exchange Server 2010.

Use the Remove-ClientAccessArray cmdlet to remove RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site).

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

Remove-EcpVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-EcpVirtualDirectory cmdlet to remove Exchange Control Panel (ECP) virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. The ECP virtual directory manages the Exchange admin center.

The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers.

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

Remove-MapiVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-MapiVirtualDirectory cmdlet to remove Message Application Programming Interface (MAPI) virtual directories from Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol.

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

Remove-OwaVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-OwaVirtualDirectory cmdlet to remove Outlook on the web virtual directories from Internet Information Services (IIS) on Exchange servers.

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

Remove-PowerShellVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-PowerShellVirtualDirectory cmdlet to remove existing Windows PowerShell virtual directories from Internet Information Services (IIS) on Exchange servers.

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

Remove-RpcClientAccess

This cmdlet is available only in Exchange Server 2010.

Use the Remove-RpcClientAccess cmdlet to remove the configuration information that allows RPC access through the Client Access server role on Microsoft Exchange Server 2010. After you remove the configuration information, the Exchange RPC Client Access service stops and no longer starts.

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

Remove-WebServicesVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-WebServicesVirtualDirectory cmdlet to remove existing Exchange Web Services virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers.

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

Set-ActiveSyncVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-ActiveSyncVirtualDirectory cmdlet to modify existing Microsoft Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Exchange servers.

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

Set-AuthRedirect

This cmdlet is available only in on-premises Exchange.

Use the Set-AuthRedirect cmdlet to modify the existing OAuth redirection settings for Microsoft Exchange 2010 Client Access servers in your Microsoft Exchange 2013 organization.

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

Set-AutodiscoverVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-AutodiscoverVirtualDirectory cmdlet to configure Autodiscover virtual directories that are used in Internet Information Services (IIS) on Exchange servers.

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

Set-ClientAccessArray

This cmdlet is available only in Exchange Server 2010.

Use the Set-ClientAccessArray cmdlet to modify RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site).

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

Set-ClientAccessServer

This cmdlet is available only in on-premises Exchange.

Use the Set-ClientAccessServer cmdlet to modify settings that are associated with the Client Access server role.

Note: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService.

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

Set-ClientAccessService

This cmdlet is available only in on-premises Exchange.

Use the Set-ClientAccessService cmdlet to modify settings that are associated with the Client Access server role.

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

Set-EcpVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-EcpVirtualDirectory cmdlet to modify Exchange Control Panel (ECP) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The ECP virtual directory manages the Exchange admin center.

The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers.

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

Set-MapiVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-MapiVirtualDirectory cmdlet to modify Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol.

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

Set-OutlookAnywhere

This cmdlet is available only in on-premises Exchange.

Use the Set-OutlookAnywhere cmdlet to modify Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. Outlook Anywhere uses virtual directories that contain "rpc" in the name.

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

Set-OwaVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-OwaVirtualDirectory cmdlet to modify existing Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Exchange servers.

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

Set-PowerShellVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-PowerShellVirtualDirectory cmdlet to modify existing Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Exchange servers.

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

Set-RpcClientAccess

This cmdlet is available only in on-premises Exchange.

Use the Set-RpcClientAccess cmdlet to modify the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP).

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

Set-WebServicesVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-WebServicesVirtualDirectory cmdlet to modify existing Exchange Web Services virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

database-availability-groups

Add-DatabaseAvailabilityGroupServer

This cmdlet is available only in on-premises Exchange.

Use the Add-DatabaseAvailabilityGroupServer cmdlet to add a Mailbox server to a database availability group (DAG). A DAG is a set of Mailbox servers that use continuous replication and managed availability to provide automatic database-level recovery from database, server, or network failures.

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

Add-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Add-MailboxDatabaseCopy cmdlet to create a passive copy of an existing active mailbox database.

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

Get-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Get-DatabaseAvailabilityGroup cmdlet to obtain a variety of configuration settings, status and other information about a database availability group (DAG).

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

Get-DatabaseAvailabilityGroupNetwork

This cmdlet is available only in on-premises Exchange.

Use the Get-DatabaseAvailabilityGroupNetwork cmdlet to display configuration and state information for a database availability group (DAG) network.

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

Get-MailboxDatabaseCopyStatus

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxDatabaseCopyStatus cmdlet to view health and status information about one or more mailbox database copies.

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

Move-ActiveMailboxDatabase

This cmdlet is available only in on-premises Exchange.

Use the Move-ActiveMailboxDatabase cmdlet to perform a database or server switchover.

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

New-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the New-DatabaseAvailabilityGroup cmdlet to create a database availability group (DAG).

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

New-DatabaseAvailabilityGroupNetwork

This cmdlet is available only in on-premises Exchange.

Use the New-DatabaseAvailabilityGroupNetwork cmdlet to create a database availability group (DAG) network.

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

Remove-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Remove-DatabaseAvailabilityGroup cmdlet to delete an empty database availability group (DAG). Before you can delete a DAG, you must first remove all Mailbox servers from the DAG.

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

Remove-DatabaseAvailabilityGroupNetwork

This cmdlet is available only in on-premises Exchange.

Use the Remove-DatabaseAvailabilityGroupNetwork cmdlet to remove a database availability group (DAG) network.

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

Remove-DatabaseAvailabilityGroupServer

This cmdlet is available only in on-premises Exchange.

Use the Remove-DatabaseAvailabilityGroupServer cmdlet to remove a Mailbox server from a database availability group (DAG). To remove a Mailbox server from a DAG, the Mailbox server must not host any replicated databases.

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

Remove-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Remove-MailboxDatabaseCopy cmdlet to remove a passive copy of a mailbox database.

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

Restore-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Restore-DatabaseAvailabilityGroup cmdlet as part of a datacenter switchover of a database availability group (DAG).

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

Resume-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Resume-MailboxDatabaseCopy cmdlet to unblock activation or resume log copying and replay for a passive mailbox database copy.

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

Set-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Set-DatabaseAvailabilityGroup cmdlet to configure properties of a database availability group (DAG).

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

Set-DatabaseAvailabilityGroupNetwork

This cmdlet is available only in on-premises Exchange.

Use the Set-DatabaseAvailabilityGroupNetwork cmdlet to configure a network for a database availability group (DAG).

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

Set-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Set-MailboxDatabaseCopy cmdlet to configure the properties of a database copy.

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

Start-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Start-DatabaseAvailabilityGroup cmdlet to reincorporate one or more previously failed members of a database availability group (DAG).

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

Stop-DatabaseAvailabilityGroup

This cmdlet is available only in on-premises Exchange.

Use the Stop-DatabaseAvailabilityGroup cmdlet to mark a member of a database availability group (DAG) as failed, or to mark all DAG members in a specific Active Directory site as failed.

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

Suspend-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Suspend-MailboxDatabaseCopy cmdlet to block replication and replay activities (log copying and replay) or activation for a database configured with two or more database copies.

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

Test-ReplicationHealth

This cmdlet is available only in on-premises Exchange.

Use the Test-ReplicationHealth cmdlet to check all aspects of replication and replay, or to provide status for a specific Mailbox server in a database availability group (DAG).

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

Update-MailboxDatabaseCopy

This cmdlet is available only in on-premises Exchange.

Use the Update-MailboxDatabaseCopy cmdlet to seed or reseed a mailbox database copy.

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

defender-for-office-365

Disable-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Disable-AntiPhishRule cmdlet to disable antiphish rules in your cloud-based organization.

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

Disable-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule cmdlets together to turn off the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365.

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

Disable-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the Disable-SafeAttachmentRule cmdlet to disable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell.

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

Disable-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the Disable-SafeLinksRule cmdlet to disable enabled Safe Links rules in your cloud-based organization.

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

Enable-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Enable-AntiPhishRule cmdlet to enable antiphish rules in your cloud-based organization.

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

Enable-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule cmdlets together to turn on the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365.

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

Enable-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the Enable-SafeAttachmentRule cmdlet to enable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell.

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

Enable-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the Enable-SafeLinksRule cmdlet to enable disabled Safe Links rules in your cloud-based organization.

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

Get-AntiPhishPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-AntiPhishPolicy cmdlet to view antiphish policies in your cloud-based organization. This cmdlet returns results only in Exchange Online PowerShell.

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

Get-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Get-AntiPhishRule cmdlet to view antiphish rules in your cloud-based organization.

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

Get-ATPBuiltInProtectionRule

This cmdlet is available only in the cloud-based service.

Use the Get-ATPBuiltInProtectionRule cmdlet to view the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy.

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

Get-AtpPolicyForO365

This cmdlet is available only in the cloud-based service.

Use the Get-AtpPolicyForO365 cmdlet to view the settings for the following features in Microsoft Defender for Office 365:

  • Safe Links protection for supported Office 365 apps.
  • Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise.
  • Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.

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

Get-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Get-ATPProtectionPolicyRule cmdlet to view rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

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

Get-ATPTotalTrafficReport

This cmdlet is available only in the cloud-based service.

Use the Get-ATPTotalTrafficReport to view details about message traffic in your Microsoft Defender for Office 365 organization.

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

Get-ContentMalwareMdoAggregateReport

This cmdlet is available only in the cloud-based service.

Use the Get-ContentMalwareMdoAggregateReport cmdlet to view a summary detections by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365.

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

Get-ContentMalwareMdoDetailReport

This cmdlet is available only in the cloud-based service.

Use the ContentMalwareMdoDetailReport cmdlet to view detection details by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365.

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

Get-EmailTenantSettings

This cmdlet is available only in the cloud-based service.

Use the Get-EmailTenantSettings cmdlet to view whether priority account protection is enabled or disabled in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see Manage and monitor priority accounts.

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

Get-MailDetailATPReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 10 days.

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

Get-MailTrafficATPReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailTrafficATPReport cmdlet to view the results of Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 90 days.

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

Get-SafeAttachmentPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-SafeAttachmentPolicy cmdlet to view safe attachment policies in your cloud-based organization.

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

Get-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the Get-SafeAttachmentRule cmdlet to view safe attachment rules in your cloud-based organization.

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

Get-SafeLinksAggregateReport

This cmdlet is available only in the cloud-based service.

Use the Get-SafeLinksAggregateReport cmdlet to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify.

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

Get-SafeLinksDetailReport

This cmdlet is available only in the cloud-based service.

Use the Get-SafeLinksDetailReport cmdlet to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify.

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

Get-SafeLinksPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-SafeLinksPolicy cmdlet to view Safe Links policies in your cloud-based organization.

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

Get-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the Get-SafeLinksRule cmdlet to view Safe Links rules in your cloud-based organization.

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

Get-SpoofIntelligenceInsight

This cmdlet is available only in the cloud-based service.

Use the Get-SpoofIntelligenceInsight cmdlet to view spoofed senders that were allowed or blocked by spoof intelligence during the last 30 days.

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

Get-SpoofMailReport

This cmdlet is available only in the cloud-based service.

Use the Get-SpoofMailReport cmdlet to view information about spoofed senders in your cloud-based organization for the past 90 days. Spoofing is where the sender of the inbound message is different than the actual source of the message (for example, the sender is lila@contoso.com, but the message was sent from the email infrastructure of fabrikam.com).

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

New-AntiPhishPolicy

This cmdlet is available only in the cloud-based service.

Use the New-AntiPhishPolicy cmdlet to create antiphish policies in your cloud-based organization.

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

New-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the New-AntiPhishRule cmdlet to create antiphish rules in your cloud-based organization.

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

New-ATPBuiltInProtectionRule

This cmdlet is available only in the cloud-based service.

Note: Don't use this cmdlet. This cmdlet is used by the system to create the one and only rule for the Built-in protection preset security policy during the creation of the organization. You can't use this cmdlet if a rule for the Built-in protection preset security policy already exists. The Remove-ATPBuiltInProtectionRule cmdlet is not available to remove rules.

Use the New-ATPBuiltInProtectionRule cmdlet to create the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy.

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

New-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the New-ATPProtectionPolicyRule cmdlet to create rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

Note: Unless you manually removed a rule using the Remove-ATPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them.

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

New-SafeAttachmentPolicy

This cmdlet is available only in the cloud-based service.

Use the New-SafeAttachmentPolicy cmdlet to create safe attachment policies in your cloud-based organization.

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

New-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the New-SafeAttachmentRule cmdlet to create safe attachment rules in your cloud-based organization.

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

New-SafeLinksPolicy

This cmdlet is available only in the cloud-based service.

Use the New-SafeLinksPolicy cmdlet to create Safe Links policies in your cloud-based organization.

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

New-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the New-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization.

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

Remove-AntiPhishPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-AntiPhishPolicy cmdlet to remove antiphish policies from your cloud-based organization.

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

Remove-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Remove-AntiPhishRule cmdlet to remove antiphish rules from your cloud-based organization.

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

Remove-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Remove-ATPProtectionPolicyRule cmdlet to remove rules from Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies.

Note: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-ATPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule.

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

Remove-SafeAttachmentPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-SafeAttachmentPolicy cmdlet to remove safe attachment policies from your cloud-based organization.

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

Remove-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the Remove-SafeAttachmentRule cmdlet to remove safe attachment rules from your cloud-based organization.

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

Remove-SafeLinksPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-SafeLinksPolicy cmdlet to remove Safe Links policies from your cloud-based organization.

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

Remove-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the Remove-SafeLinksRule cmdlet to remove Safe Links rules from your cloud-based organization.

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

Set-AntiPhishPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-AntiPhishPolicy cmdlet to modify antiphish policies in your cloud-based organization.

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

Set-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Set-AntiPhishRule cmdlet to modify antiphish rules in your cloud-based organization.

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

Set-ATPBuiltInProtectionRule

This cmdlet is available only in the cloud-based service.

Use the Set-ATPBuiltInProtectionRule cmdlet to modify the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy.

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

Set-AtpPolicyForO365

This cmdlet is available only in the cloud-based service.

Use the Set-AtpPolicyForO365 cmdlet to modify the settings for the following features in Microsoft Defender for Office 365:

  • Safe Links protection for supported Office 365 apps.
  • Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise.
  • Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.

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

Set-ATPProtectionPolicyRule

This cmdlet is available only in the cloud-based service.

Use the Set-ATPProtectionPolicyRule cmdlet to modify rules that are associated with Microsoft Defender for Office 365 protections in preset security policies.

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

Set-EmailTenantSettings

This cmdlet is available only in the cloud-based service.

Use the Set-EmailTenantSettings cmdlet to enable or disable priority account protection in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see Manage and monitor priority accounts.

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

Set-SafeAttachmentPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-SafeAttachmentPolicy cmdlet to modify safe attachment policies in your cloud-based organization.

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

Set-SafeAttachmentRule

This cmdlet is available only in the cloud-based service.

Use the Set-SafeAttachmentRule cmdlet to modify safe attachment rules in your cloud-based organization.

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

Set-SafeLinksPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-SafeLinksPolicy cmdlet to modify Safe Links policies in your cloud-based organization.

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

Set-SafeLinksRule

This cmdlet is available only in the cloud-based service.

Use the Set-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization.

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

devices

Clear-ActiveSyncDevice

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

Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile device.

Note: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice.

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

Clear-MobileDevice

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

Use the Clear-MobileDevice cmdlet to delete all data from a mobile phone. This action is often called a remote device wipe.

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

Export-ActiveSyncLog

This cmdlet is available only in on-premises Exchange.

Use the Export-ActiveSyncLog cmdlet to parse the Internet Information Services (IIS) logs and return information about Microsoft Exchange ActiveSync usage, either on the screen or in an output file.

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

Get-ActiveSyncDevice

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

Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships.

Note: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice.

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

Get-ActiveSyncDeviceAccessRule

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

Use the Get-ActiveSyncDeviceAccessRule cmdlet to retrieve an access group of Exchange mobile devices along with their access level.

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

Get-ActiveSyncDeviceAutoblockThreshold

This cmdlet is available only in on-premises Exchange.

Use the Get-ActiveSyncDeviceAutoblockThreshold cmdlet to obtain the Autoblock settings for Microsoft Exchange ActiveSync mobile devices.

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

Get-ActiveSyncDeviceClass

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

Use the Get-ActiveSyncDeviceClass cmdlet to retrieve a list of ActiveSync devices that have connected to your organization. The cmdlet returns the mobile device type and model information.

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

Get-ActiveSyncDeviceStatistics

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

Use the Get-ActiveSyncDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange or Exchange Online, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics.

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

Get-ActiveSyncMailboxPolicy

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

Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy.

Note: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy.

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

Get-ActiveSyncOrganizationSettings

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

Use the Get-ActiveSyncOrganizationSettings cmdlet to view the Microsoft Exchange ActiveSync settings for your organization.

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

Get-DeviceConditionalAccessPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceConditionalAccessPolicy cmdlet to view mobile device conditional access policies in Basic Mobility and Security in Microsoft 365.

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

Get-DeviceConditionalAccessRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceConditionalAccessRule cmdlet to view mobile device conditional access rules in Basic Mobility and Security in Microsoft 365.

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

Get-DeviceConfigurationPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceConfigurationPolicy cmdlet to view mobile device configuration policies in Basic Mobility and Security in Microsoft 365.

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

Get-DeviceConfigurationRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceConfigurationRule cmdlet to view mobile device configuration rules in Basic Mobility and Security in Microsoft 365.

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

Get-DevicePolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DevicePolicy cmdlet to view all types of Basic Mobility and Security policies in Microsoft 365.

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

Get-DeviceTenantPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceTenantPolicy cmdlet to view your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365.

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

Get-DeviceTenantRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DeviceTenantRule cmdlet to view your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365.

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

Get-MobileDevice

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

Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active partnerships.

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

Get-MobileDeviceMailboxPolicy

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

Use the Get-MobileDeviceMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy.

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

Get-MobileDeviceStatistics

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

Use the Get-MobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMobileDeviceStatistics cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

New-ActiveSyncDeviceAccessRule

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

Use the New-ActiveSyncDeviceAccessRule cmdlet to define the access levels for Exchange ActiveSync devices based on the identity of the device.

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

New-ActiveSyncMailboxPolicy

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

Use the New-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device mailbox policy object.

Note: In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy.

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

New-DeviceConditionalAccessPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceConditionalAccessPolicy cmdlet to create mobile device conditional access policies in Basic Mobility and Security in Microsoft 365.

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

New-DeviceConditionalAccessRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceConditionalAccessRule cmdlet to create mobile device conditional access rules in Basic Mobility and Security in Microsoft 365.

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

New-DeviceConfigurationPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceConfigurationPolicy cmdlet to create mobile device configuration policies in Basic Mobility and Security in Microsoft 365.

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

New-DeviceConfigurationRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceConfigurationRule cmdlet to create mobile device configuration rules in Basic Mobility and Security in Microsoft 365.

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

New-DeviceTenantPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceTenantPolicy cmdlet to create your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365.

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

New-DeviceTenantRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DeviceTenantRule cmdlet to create your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365.

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

New-MobileDeviceMailboxPolicy

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

Use the New-MobileDeviceMailboxPolicy cmdlet to create mobile device mailbox policies.

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

Remove-ActiveSyncDevice

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

Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes.

Note: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice.

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

Remove-ActiveSyncDeviceAccessRule

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

Use the Remove-ActiveSyncDeviceAccessRule cmdlet to remove any existing device access rule.

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

Remove-ActiveSyncDeviceClass

This cmdlet is available only in on-premises Exchange.

Use the Remove-ActiveSyncDeviceClass cmdlet to clean up the list of mobile devices synchronizing with Microsoft Exchange.

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

Remove-ActiveSyncMailboxPolicy

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

Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox policies.

Note: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy.

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

Remove-DeviceConditionalAccessPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DeviceConditionalAccessPolicy cmdlet to remove mobile device conditional access policies from Basic Mobility and Security in Microsoft 365.

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

Remove-DeviceConditionalAccessRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DeviceConditionalAccessRule cmdlet to remove mobile device conditional access rules from Basic Mobility and Security in Microsoft 365.

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

Remove-DeviceConfigurationPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DeviceConfigurationPolicy cmdlet to remove mobile device configuration policies from Basic Mobility and Security in Microsoft 365.

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

Remove-DeviceConfigurationRule

This cmdlet is available only in the cloud-based service.

Use the Remove-DeviceConfigurationRule cmdlet to remove mobile device configuration rules from Basic Mobility and Security in Microsoft 365.

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

Remove-DeviceTenantPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DeviceTenantPolicy cmdlet to remove your organization's mobile device tenant policy from Basic Mobility and Security in Microsoft 365.

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

Remove-DeviceTenantRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DeviceTenantRule cmdlet to remove your organization's mobile device tenant rule from Basic Mobility and Security in Microsoft 365.

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

Remove-MobileDevice

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

Use the Remove-MobileDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes.

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

Remove-MobileDeviceMailboxPolicy

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

Use the Remove-MobileDeviceMailboxPolicy cmdlet to remove mobile device mailbox policies from Exchange servers.

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

Set-ActiveSyncDeviceAccessRule

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

Use the Set-ActiveSyncDeviceAccessRule cmdlet to set the level of access for the rule.

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

Set-ActiveSyncDeviceAutoblockThreshold

This cmdlet is available only in on-premises Exchange.

Use the Set-ActiveSyncDeviceAutoblockThreshold cmdlet to change settings for autoblocking mobile devices.

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

Set-ActiveSyncMailboxPolicy

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

Use the Set-ActiveSyncMailboxPolicy cmdlet to apply a variety of Mobile Device mailbox policy settings to a server. You can set any of the parameters by using one command.

Note: In Exchange 2013 or later, use the Set-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Set-ActiveSyncMailboxPolicy, update them to use Set-MobileDeviceMailboxPolicy.

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

Set-ActiveSyncOrganizationSettings

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

Use the Set-ActiveSyncOrganizationSettings cmdlet to set the Exchange ActiveSync settings for the organization.

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

Set-DeviceConditionalAccessPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceConditionalAccessPolicy cmdlet to modify mobile device conditional access policies in Basic Mobility and Security in Microsoft 365.

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

Set-DeviceConditionalAccessRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceConditionalAccessRule cmdlet to modify mobile device conditional access rules in Basic Mobility and Security in Microsoft 365.

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

Set-DeviceConfigurationPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceConfigurationPolicy cmdlet to modify mobile device configuration policies in Basic Mobility and Security in Microsoft 365.

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

Set-DeviceConfigurationRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceConfigurationRule cmdlet to modify mobile device configuration rules in Basic Mobility and Security in Microsoft 365.

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

Set-DeviceTenantPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceTenantPolicy cmdlet to modify your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365.

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

Set-DeviceTenantRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DeviceTenantRule cmdlet to modify your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365.

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

Set-MobileDeviceMailboxPolicy

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

Use the Set-MobileDeviceMailboxPolicy cmdlet to modify mobile device mailbox policies.

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

Test-ActiveSyncConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-ActiveSyncConnectivity cmdlet to test connectivity to Microsoft Exchange ActiveSync virtual directories.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

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

email-addresses-and-address-books

Disable-AddressListPaging

This cmdlet is available only in on-premises Exchange.

Use the Disable-AddressListPaging cmdlet to disable Active Directory virtual list view for address lists. Virtual list view displays address lists in your organization as pages instead of loading and viewing the entire directory.

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

Enable-AddressListPaging

This cmdlet is available only in on-premises Exchange.

Use the Enable-AddressListPaging cmdlet to enable Active Directory virtual list view for address lists. Virtual list view allows you to display the address lists in your organization as pages instead of loading and viewing the entire directory.

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

Get-AddressBookPolicy

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

Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-AddressList

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

Use the Get-AddressList cmdlet to view address lists.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-DetailsTemplate

This cmdlet is available only in on-premises Exchange.

Use the Get-DetailsTemplate cmdlet to retrieve the attributes for details templates.

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

Get-EmailAddressPolicy

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

Use the Get-EmailAddressPolicy cmdlet to view email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups.

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

Get-GlobalAddressList

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

Use the Get-GlobalAddressList cmdlet to view a global address list (GAL) or a set of GALs.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-OabVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Get-OabVirtualDirectory cmdlet to view offline address book (OAB) virtual directories(OAB distribution points) that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

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

Get-OfflineAddressBook

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

Use the Get-OfflineAddressBook cmdlet to view offline address books (OABs).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Move-AddressList

This cmdlet is available only in on-premises Exchange.

Use the Move-AddressList cmdlet to move an existing address list to a new container under the root address list.

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

Move-OfflineAddressBook

This cmdlet is available only in on-premises Exchange.

Use the Move-OfflineAddressBook cmdlet to designate a new server that's responsible for generating the offline address book (OAB) in Exchange Server 2010. This cmdlet isn't used on OABs in Exchange Server 2016 or Exchange Server 2013. To perform this task in Exchange 2016 or Exchange 2013, use the Set-OfflineAddressBook cmdlet with the GeneratingMailbox parameter.

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

New-AddressBookPolicy

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

Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

New-AddressList

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

Use the New-AddressList cmdlet to create address lists and apply them to recipients.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

New-EmailAddressPolicy

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

Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups.

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

New-GlobalAddressList

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

Use the New-GlobalAddressList cmdlet to create a global address list (GAL).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

New-OabVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the New-OABVirtualDirectory cmdlet to create offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The OAB virtual directory configures the server as a web distribution point for an offline address book (OAB). Typically, you create virtual directories on Exchange servers that have the Client Access server role installed.

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

New-OfflineAddressBook

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

Use the New-OfflineAddressBook cmdlet to create offline address books (OABs).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Remove-AddressBookPolicy

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

Use the Remove-AddressBookPolicy cmdlet to delete an address book policy. You can't remove the address book policy if it's still assigned to a user's mailbox.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Remove-AddressList

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

Use the Remove-AddressList cmdlet to remove existing address lists.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Remove-EmailAddressPolicy

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

Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are available only for Microsoft 365 Groups.

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

Remove-GlobalAddressList

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

Use the Remove-GlobalAddressList cmdlet to remove an existing global address list (GAL).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Remove-OabVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Remove-OabVirtualDirectory cmdlet to remove offline address book (OAB) virtual directories from Internet Information Services (IIS) on Exchange servers.

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

Remove-OfflineAddressBook

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

Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Restore-DetailsTemplate

This cmdlet is available only in on-premises Exchange.

Use the Restore-DetailsTemplate cmdlet to restore the specified template to its default state.

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

Set-AddressBookPolicy

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

Use the Set-AddressBookPolicy cmdlet to change the settings of an address book policy.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Set-AddressList

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

Use the Set-AddressList cmdlet to modify existing address lists.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Set-DetailsTemplate

This cmdlet is available only in on-premises Exchange.

Use the Set-DetailsTemplate cmdlet to modify the attributes of a details template. To make changes to the details template format and layout, you need to use the Details Templates Editor in the Exchange Toolbox.

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

Set-EmailAddressPolicy

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

Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups.

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

Set-GlobalAddressList

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

Use the Set-GlobalAddressList cmdlet to modify an existing global address list (GAL).

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Set-OabVirtualDirectory

This cmdlet is available only in on-premises Exchange.

Use the Set-OABVirtualDirectory cmdlet to modify offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Exchange servers.

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

Set-OfflineAddressBook

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

Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Update-AddressList

This cmdlet is available only in on-premises Exchange.

Use the Update-AddressList cmdlet to update the recipients included in address lists.

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

Update-EmailAddressPolicy

This cmdlet is available only in on-premises Exchange.

Use the Update-EmailAddressPolicy cmdlet to apply new or updated email address policies to the affected recipients in an on-premises Exchange organization.

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

Update-GlobalAddressList

This cmdlet is available only in on-premises Exchange.

Use the Update-GlobalAddressList cmdlet to update the recipients included in a global address list (GAL).

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

Update-OfflineAddressBook

This cmdlet is available only in on-premises Exchange.

Use the Update-OfflineAddressBook cmdlet to update the offline address books (OABs) used by Microsoft Outlook clients.

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

encryption-and-certificates

Enable-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the Enable-ExchangeCertificate cmdlet to enable an existing certificate on the Exchange server for Exchange services such as Internet Information Services (IIS), SMTP, POP, IMAP and Unified Messaging (UM). Once you enable a certificate for a service, you can't disable it.

To see the existing certificates that are used for Exchange services, use Get-ExchangeCertificate.

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

Export-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the Export-ExchangeCertificate cmdlet to export existing certificates and pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers.

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

Get-DataEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-DataEncryptionPolicy cmdlet to view data encryption policies in Exchange Online.

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

Get-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeCertificate cmdlet to view Exchange certificates that are installed on Exchange servers. This cmdlet returns Exchange self-signed certificates, certificates that were issued by a certification authority and pending certificate requests (also known as certificate signing requests or CSRs).

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

Get-IRMConfiguration

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

Use the Get-IRMConfiguration cmdlet to view the Information Rights Management (IRM) configuration in your organization.

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

Get-M365DataAtRestEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-M365DataAtRestEncryptionPolicy cmdlet to view existing Microsoft 365 data-at-rest encryption policies.

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

Get-M365DataAtRestEncryptionPolicyAssignment

This cmdlet is available only in the cloud-based service.

Use the Get-M365DataAtRestEncryptionPolicyAssignment cmdlet to view the currently assigned Microsoft 365 data-at-rest encryption policy.

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

Get-MailboxIRMAccess

This cmdlet is available only in the cloud-based service.

Use the Get-MailboxIRMAccess cmdlet to view delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission).

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

Get-OMEConfiguration

This cmdlet is available only in the cloud-based service.

Use the Get-OMEConfiguration cmdlet to view Microsoft Purview Message Encryption configurations.

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

Get-OMEMessageStatus

This cmdlet is available only in the cloud-based service.

Use the Get-OMEMessageStatus cmdlet to view the Microsoft Purview Message Encryption revocation status for a specific message.

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

Get-RMSTemplate

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

Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization.

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

Get-SmimeConfig

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

Use the Get-SmimeConfig cmdlet to view the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App).

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

Import-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the Import-ExchangeCertificate cmdlet to import certificates on Exchange servers. You use this cmdlet to install certificates that were exported from other servers, and to complete pending certification requests (also known as certificate signing requests or CSRs) from certification authorities (CAs).

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

New-DataEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the New-DataEncryptionPolicy cmdlet to create data encryption policies in Exchange Online.

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

New-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the New-ExchangeCertificate cmdlet to create and renew self-signed certificates, and to create certificate requests (also known as certificate signing requests or CSRs) for new certificates and certificate renewals from a certification authority (CA).

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

New-M365DataAtRestEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy.

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

New-OMEConfiguration

This cmdlet is available only in the cloud-based service.

Use the New-OMEConfiguration cmdlet to create a Microsoft Purview Message Encryption configuration.

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

Remove-ExchangeCertificate

This cmdlet is available only in on-premises Exchange.

Use the Remove-ExchangeCertificate cmdlet to remove existing Exchange certificates or pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers.

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

Remove-MailboxIRMAccess

This cmdlet is available only in the cloud-based service.

Use the Remove-MailboxIRMAccess cmdlet to allow (unblock) delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission).

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

Remove-OMEConfiguration

This cmdlet is available only in the cloud-based service.

Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft Purview Message Encryption configurations. You can't use this cmdlet to remove the default OME configuration.

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

Set-DataEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-DataEncryptionPolicy cmdlet to modify data encryption policies in Exchange Online.

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

Set-IRMConfiguration

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

Use the Set-IRMConfiguration cmdlet to configure Information Rights Management (IRM) features on your organization.

Configuring and using IRM features in an on-premises Exchange organization requires Active Directory Rights Management Services (AD RMS).

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

Set-M365DataAtRestEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-M365DataAtRestEncryptionPolicy cmdlet to modify Microsoft 365 data-at-rest encryption policies in Exchange Online.

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

Set-M365DataAtRestEncryptionPolicyAssignment

This cmdlet is available only in the cloud-based service.

Use the Set-M365DataAtRestEncryptionPolicyAssignment cmdlet to assign a Microsoft 365 data-at-rest encryption policy at the tenant level.

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

Set-MailboxIRMAccess

This cmdlet is available only in the cloud-based service.

Use the Set-MailboxIRMAccess cmdlet to block delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission).

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

Set-OMEConfiguration

This cmdlet is available only in the cloud-based service.

Use the Set-OMEConfiguration cmdlet to configure Microsoft Purview Message Encryption.

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

Set-OMEMessageRevocation

This cmdlet is available only in the cloud-based service.

Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft Purview Message Encryption for a message. Revoking encryption prevents the recipient from viewing the message in the OME portal.

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

Set-RMSTemplate

This cmdlet is available only in the cloud-based service.

Note

This cmdlet has been deprecated. If you use AD RMS with Exchange Online, you need to migrate to Azure Information Protection before you can use message encryption. For more information, see Verify that Azure Rights Management is active.

Use the Set-RMSTemplate cmdlet to modify the properties of an existing Active Directory Rights Management Services (AD RMS) template in your organization.

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

Set-SmimeConfig

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

Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App).

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

Test-IRMConfiguration

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

Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality.

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

Test-M365DataAtRestEncryptionPolicy

This cmdlet is available only in the cloud-based service.

Use the Test-M365DataAtRestEncryptionPolicy cmdlet to test an existing Microsoft 365 data-at-rest encryption policy.

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

ExchangePowerShell

Get-MailFlowStatusReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailFlowStatusReport cmdlet to return the message counts for a specific date range organized by the final disposition of the message for the last 90 days.

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

Get-VivaFeatureCategory

This cmdlet is available only in the Exchange Online PowerShell module v3.5.0 or later. For more information, see About the Exchange Online PowerShell module.

Note: While we are adding support for category policies in the Exchange Online PowerShell module v3.5.0-Preview1 or later, we have not yet released any categories in Viva. We will update when there are categories available.

Use the Get-VivaFeatureCategory cmdlet to view all categories in Viva that support feature access controls. This cmdlet provides details about the categories, including the category identifiers, descriptions, and Viva module features that belong to the category. A category contains a group of features in the same or different Viva module.

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

set-ExoSecOpsOverrideRule

This cmdlet is available only in the cloud-based service.

Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes.

Tip: This cmdlet doesn't modify email addresses in the SecOps override rule. To modify the email addresses in the SecOps override rule, use the Set-SecOpsOverridePolicy cmdlet.

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

federation-and-hybrid

Add-FederatedDomain

This cmdlet is available only in on-premises Exchange.

Use the Add-FederatedDomain cmdlet to configure a secondary domain with the federated organization identifier in the federation trust for the Exchange organization.

The domains being added to the federation trust must exist as accepted domains in the Exchange organization.

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

Disable-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Disable-RemoteMailbox cmdlet to remove user mailboxes from the cloud-based service but keep the associated user objects in the on-premises Active Directory.

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

Enable-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Enable-RemoteMailbox cmdlet to create a mailbox in the cloud-based service for an existing user in the on-premises Active Directory.

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

Get-FederatedDomainProof

This cmdlet is available only in on-premises Exchange.

Use the Get-FederatedDomainProof cmdlet to generate a cryptographically secure string for the domain used for federated sharing in your Exchange organization.

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

Get-FederatedOrganizationIdentifier

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

Use the Get-FederatedOrganizationIdentifier cmdlet to retrieve the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact and status.

For more information, see Federation.

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

Get-FederationInformation

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

Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization.

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

Get-FederationTrust

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

Use the Get-FederationTrust cmdlet to view the federation trust configured for the Exchange organization.

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

Get-HybridConfiguration

This cmdlet is available only in on-premises Exchange.

Use the Get-HybridConfiguration cmdlet to view the hybrid configuration for the Microsoft Exchange organization.

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

Get-HybridMailflowDatacenterIPs

This cmdlet is available only in the cloud-based service.

This cmdlet has been deprecated and is no longer used.

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

Get-IntraOrganizationConfiguration

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

Use the Get-IntraOrganizationConfiguration cmdlet to view the component settings of a hybrid Exchange deployment.

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

Get-IntraOrganizationConnector

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

Use the Get-IntraOrganizationConnector cmdlet to view the settings of Intra-Organization connectors.

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

Get-OnPremisesOrganization

This cmdlet is available only in the cloud-based service.

Use the Get-OnPremisesOrganization cmdlet to retrieve settings for the OnPremisesOrganization object that has been created for a hybrid deployment.

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

Get-PendingFederatedDomain

This cmdlet is available only in on-premises Exchange.

The Get-PendingFederatedDomain cmdlet is used by the Exchange admin center to display a list of pending federated domains for the federation trust for your Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust.

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

Get-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Get-RemoteMailbox cmdlet to retrieve the mail-related attributes of users in the on-premises organization that have associated mailboxes in the cloud-based service.

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

New-FederationTrust

This cmdlet is available only in on-premises Exchange.

Use the New-FederationTrust cmdlet to set up a federation trust between your Exchange organization and the Microsoft Federation Gateway.

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

New-HybridConfiguration

This cmdlet is available only in on-premises Exchange.

Use the New-HybridConfiguration cmdlet to create the HybridConfiguration object and set up a hybrid deployment between your on-premises Exchange organization and a Microsoft 365 for enterprises organization.

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

New-IntraOrganizationConnector

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

Use the New-IntraOrganizationConnector cmdlet to create an Intra-Organization connector between two on-premises Exchange forests in an organization, between an Exchange on-premises organization and an Exchange Online organization, or between two Exchange Online organizations. This connector enables feature availability and service connectivity across the organizations using a common connector and connection endpoints.

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

New-OnPremisesOrganization

This cmdlet is available only in the cloud-based service.

Use the New-OnPremisesOrganization cmdlet to create an OnPremisesOrganization object in a Microsoft 365 organization.

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

New-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the New-RemoteMailbox cmdlet to create a mail user in the on-premises Active Directory and also create an associated mailbox in the cloud-based service.

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

Remove-FederatedDomain

This cmdlet is available only in on-premises Exchange.

Use the Remove-FederatedDomain cmdlet to remove a federated domain from the federated organization identifier in the federation trust for the Exchange organization.

If you remove a domain configured for federated sharing, federated sharing for that domain is disabled.

For more information, see Federation.

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

Remove-FederationTrust

This cmdlet is available only in on-premises Exchange.

Use the Remove-FederationTrust cmdlet to remove an existing federation trust from an Exchange organization.

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

Remove-HybridConfiguration

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

Use the Remove-HybridConfiguration cmdlet to delete the HybridConfigurationActive Directory object for your on-premises Exchange organization.

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

Remove-IntraOrganizationConnector

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

Use the Remove-IntraOrganizationConnector cmdlet to remove existing Intra-Organization connectors.

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

Remove-OnPremisesOrganization

This cmdlet is available only in the cloud-based service.

Use the Remove-OnPremisesOrganization cmdlet to remove an OnPremisesOrganization object in a Microsoft 365 tenant.

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

Remove-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Remove-RemoteMailbox cmdlet to remove a mail-enabled user in the on-premises Active Directory and the associated mailbox in the cloud-based service.

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

Set-FederatedOrganizationIdentifier

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

Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization.

For more details, see Federation.

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

Set-FederationTrust

This cmdlet is available only in on-premises Exchange.

Use the Set-FederationTrust cmdlet to modify an existing federation trust.

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

Set-HybridConfiguration

This cmdlet is available only in on-premises Exchange.

Use the Set-HybridConfiguration cmdlet to modify the hybrid deployment between your on-premises Exchange organization and Exchange Online in a Microsoft 365 for enterprises organization.

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

Set-IntraOrganizationConnector

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

Use the Set-IntraOrganizationConnector cmdlet to modify an existing Intra-Organization connector between two on-premises Exchange forests in an organization, between an on-premises Exchange organization and an Exchange Online organization or between two Exchange Online organizations.

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

Set-OnPremisesOrganization

This cmdlet is available only in the cloud-based service.

Use the Set-OnPremisesOrganization cmdlet to modify the parameters of the OnPremisesOrganization object on the Microsoft 365 tenant.

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

Set-PendingFederatedDomain

This cmdlet is available only in on-premises Exchange.

The Set-PendingFederatedDomain cmdlet is used by the Exchange admin center to configure pending domains with the federated organization identifier in the federation trust for the Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust.

The domains being added to the federation trust must exist as accepted domains in the Exchange organization.

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

Set-RemoteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Set-RemoteMailbox cmdlet to modify remote mailboxes. A remote mailbox is a mail user in Active Directory that's associated with a mailbox in the cloud-based service.

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

Test-FederationTrust

This cmdlet is available only in on-premises Exchange.

Use the Test-FederationTrust cmdlet to verify that the federation trust is properly configured and functioning as expected.

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

Test-FederationTrustCertificate

This cmdlet is available only in on-premises Exchange.

Use the Test-FederationTrustCertificate cmdlet to check the status of certificates that are used for federation on all Exchange servers.

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

Update-HybridConfiguration

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

Use the Update-HybridConfiguration cmdlet to define the credentials that are used to update the hybrid configuration object.

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

Update-Recipient

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

Use the Update-Recipient cmdlet to add Exchange attributes to recipient objects.

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

mail-flow

Add-ResubmitRequest

This cmdlet is available only in on-premises Exchange.

Use the Add-ResubmitRequest cmdlet to add requests to replay redundant copies of messages from Safety Net after a mailbox database recovery.

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

Disable-DnssecForVerifiedDomain

This cmdlet is available only in the cloud-based service.

Use the Disable-DnssecForVerifiedDomain cmdlet to disable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online.

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

Disable-IPv6ForAcceptedDomain

This cmdlet is available only in the cloud-based service.

Use the Disable-IPv6ForAcceptedDomain cmdlet to disable or opt-out of support for mail delivery to accepted domains in Exchange Online using IPv6.

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

Disable-SmtpDaneInbound

This cmdlet is available only in the cloud-based service.

Use the Disable-SMTPDaneInbound cmdlet to disable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online.

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

Disable-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Disable-TransportAgent cmdlet to disable a transport agent.

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

Enable-DnssecForVerifiedDomain

This cmdlet is available only in the cloud-based service.

Use the Enable-DnssecForVerifiedDomain cmdlet to enable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online.

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

Enable-IPv6ForAcceptedDomain

This cmdlet is available only in the cloud-based service.

Use the Enable-IPv6ForAcceptedDomain cmdlet to enable support for mail delivery to accepted domains in Exchange Online using IPv6.

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

Enable-SmtpDaneInbound

This cmdlet is available only in the cloud-based service.

Use the Enable-SMTPDaneInbound cmdlet to enable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online.

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

Enable-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Enable-TransportAgent cmdlet to enable a transport agent.

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

Export-Message

This cmdlet is available only in on-premises Exchange.

Use the Export-Message cmdlet to copy a message from a queue on a Mailbox server or an Edge Transport server to a specified file path in your organization.

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

Get-AcceptedDomain

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

Use the Get-AcceptedDomain cmdlet to view the configuration information for the accepted domains in your organization.

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

Get-AddressRewriteEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Get-AddressRewriteEntry cmdlet to view an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server.

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

Get-DeliveryAgentConnector

This cmdlet is available only in on-premises Exchange.

Use the Get-DeliveryAgentConnector cmdlet to retrieve information about a specific delivery agent connector in your organization.

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

Get-DnssecStatusForVerifiedDomain

This cmdlet is available only in the cloud-based service.

Use the Get-DnssecStatusForVerifiedDomain cmdlet to view information about Domain Name System Security (DNSSEC) for accepted domains in Exchange Online.

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

Get-EdgeSubscription

This cmdlet is available only in on-premises Exchange.

Use the Get-EdgeSubscription cmdlet to retrieve information about Edge Subscriptions in your organization.

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

Get-EdgeSyncServiceConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-EdgeSyncServiceConfig cmdlet to retrieve the edge synchronization services settings that control the general synchronization behavior shared by all Microsoft Exchange EdgeSync services.

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

Get-ForeignConnector

This cmdlet is available only in on-premises Exchange.

Use the Get-ForeignConnector cmdlet to view the configuration information for a Foreign connector in the Transport service of a Mailbox server.

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

Get-FrontendTransportService

This cmdlet is available only in on-premises Exchange.

Use the Get-FrontEndTransportService cmdlet to view the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed.

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

Get-InboundConnector

This cmdlet is available only in the cloud-based service.

Use the Get-InboundConnector cmdlet to view the settings for an Inbound connector in your cloud-based organization.

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

Get-IPv6StatusForAcceptedDomain

This cmdlet is available only in the cloud-based service.

Use the Get-IPv6StatusForAcceptedDomain cmdlet to view the status of support for mail delivery to accepted domains in Exchange Online using IPv6.

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

Get-MailboxTransportService

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxTransportService cmdlet to view the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers.

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

Get-Message

This cmdlet is available only in on-premises Exchange.

Use the Get-Message cmdlet to view the details of one or more messages in queues on Mailbox servers or Edge Transport servers.

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

Get-MessageTrace

This cmdlet is available only in the cloud-based service.

Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization.

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

Get-MessageTraceDetail

This cmdlet is available only in the cloud-based service.

Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results.

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

Get-MessageTrackingLog

This cmdlet is available only in on-premises Exchange.

Use the Get-MessageTrackingLog cmdlet to search for message delivery information stored in the message tracking log.

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

Get-MessageTrackingReport

This cmdlet is functional only in on-premises Exchange.

Use the Get-MessageTrackingReport cmdlet to return data for a specific message tracking report. This cmdlet is used by the delivery reports feature.

In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets).

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

Get-NetworkConnectionInfo

This cmdlet is available only in on-premises Exchange.

Use the Get-NetworkConnectionInfo cmdlet to view the network configuration information for all network adapters configured on the local server.

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

Get-OutboundConnector

This cmdlet is available only in the cloud-based service.

Use the Get-OutboundConnector cmdlet to view the configuration information for an Outbound connector in your cloud-based organization.

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

Get-Queue

This cmdlet is available only in on-premises Exchange.

Use the Get-Queue cmdlet to view configuration information for queues on Mailbox servers or Edge Transport servers.

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

Get-QueueDigest

This cmdlet is available only in on-premises Exchange.

Use the Get-QueueDigest cmdlet to view information about message delivery queues across database availability groups (DAGs) Active Directory sites, or Active Directory forests in your organization.

By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see Configure Get-QueueDigest.

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

Get-ReceiveConnector

This cmdlet is available only in on-premises Exchange.

Use the Get-ReceiveConnector cmdlet to view Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server.

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

Get-RemoteDomain

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

Use the Get-RemoteDomain cmdlet to view the configuration information for the remote domains configured in your organization. You can view the remote domain configuration from inside the Exchange organization or from an Edge Transport server in the perimeter network.

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

Get-ResubmitRequest

This cmdlet is available only in on-premises Exchange.

Use the Get-ResubmitRequest cmdlet to view requests to replay redundant copies of messages from Safety Net after a mailbox database recovery.

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

Get-RoutingGroupConnector

This cmdlet is available only in Exchange Server 2010.

Use the Get-RoutingGroupConnector cmdlet to view the configuration details of the routing group connectors in a Microsoft Exchange Server 2010 organization.

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

Get-SendConnector

This cmdlet is available only in on-premises Exchange.

Use the Get-SendConnector cmdlet to view the settings for a Send connector.

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

Get-SmtpDaneInboundStatus

This cmdlet is available only in the cloud-based service.

Use the Get-SmtpDaneInboundStatus cmdlet to view information about SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online.

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

Get-SystemMessage

This cmdlet is available only in on-premises Exchange.

Use the Get-SystemMessage cmdlet to view default or custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages.

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

Get-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Get-TransportAgent cmdlet to view the configuration of a transport agent.

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

Get-TransportConfig

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

Use the Get-TransportConfig cmdlet to view organization-wide transport configuration settings.

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

Get-TransportPipeline

This cmdlet is available only in on-premises Exchange.

Use the Get-TransportPipeline cmdlet to view transport agents and the SMTP event where the transport agent is registered.

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

Get-TransportServer

This cmdlet is available only in on-premises Exchange.

Use the Get-TransportServer cmdlet to view settings that are associated with the Hub Transport server role or the Edge Transport server role.

Note: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService.

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

Get-TransportService

This cmdlet is available only in on-premises Exchange.

Use the Get-TransportService cmdlet to view the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers.

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

Get-X400AuthoritativeDomain

This cmdlet is available only in on-premises Exchange.

Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see Set-X400AuthoritativeDomain.

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

Install-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Install-TransportAgent cmdlet to register transport agents on Exchange servers.

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

New-AcceptedDomain

This cmdlet is available only in on-premises Exchange.

Use the New-AcceptedDomain cmdlet to create an accepted domain in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email.

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

New-AddressRewriteEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the New-AddressRewriteEntry cmdlet to create an address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server.

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

New-DeliveryAgentConnector

This cmdlet is available only in on-premises Exchange.

The New-DeliveryAgentConnector cmdlet creates a delivery agent connector in your organization.

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

New-EdgeSubscription

This cmdlet is available only in on-premises Exchange.

Use the New-EdgeSubscription cmdlet to export an Edge Subscription file from an Edge Transport server and to import the Edge Subscription file to a Mailbox server.

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

New-EdgeSyncServiceConfig

This cmdlet is available only in on-premises Exchange.

Use the New-EdgeSyncServiceConfig cmdlet to create edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services.

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

New-ForeignConnector

This cmdlet is available only in on-premises Exchange.

Use the New-ForeignConnector cmdlet to create a new Foreign connector in the Transport service of a Mailbox server.

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

New-InboundConnector

This cmdlet is available only in the cloud-based service.

Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization.

Note: Creation of inbound connectors is restricted in Microsoft 365 E5 developer subscriptions. Opening a support ticket in affected organizations won't help.

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

New-OutboundConnector

This cmdlet is available only in the cloud-based service.

Use the New-OutboundConnector cmdlet to create a new Outbound connector in your cloud-based organization.

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

New-ReceiveConnector

This cmdlet is available only in on-premises Exchange.

Use the New-ReceiveConnector cmdlet to create Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server.

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

New-RemoteDomain

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

Use the New-RemoteDomain cmdlet to create a managed connection for a remote domain. When you create a remote domain, you can control mail flow with more precision, apply message formatting and messaging policies and specify acceptable character sets for messages sent to and received from the remote domain.

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

New-RoutingGroupConnector

This cmdlet is available only in Exchange Server 2010.

Use the New-RoutingGroupConnector cmdlet to establish a connection between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group when the organization is running more than one version of Exchange.

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

New-SendConnector

This cmdlet is available only in on-premises Exchange.

Use the New-SendConnector cmdlet to create a new Send connector.

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

New-SystemMessage

This cmdlet is available only in on-premises Exchange.

Use the New-SystemMessage cmdlet to create custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages.

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

New-X400AuthoritativeDomain

This cmdlet is available only in on-premises Exchange.

Use the New-X400AuthoritativeDomain cmdlet to create and specify the X.400 authoritative domain for the organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address.

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

Redirect-Message

This cmdlet is available only in on-premises Exchange.

Use the Redirect-Message cmdlet to drain the active messages from all the delivery queues on a Mailbox server, and transfer those messages to another Mailbox server.

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

Remove-AcceptedDomain

This cmdlet is available only in on-premises Exchange.

Use the Remove-AcceptedDomain cmdlet to remove an accepted domain. When you remove an accepted domain, the accepted domain object is deleted.

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

Remove-AddressRewriteEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Remove-AddressRewriteEntry cmdlet to remove an existing address rewrite entry that's no longer needed on an Edge Transport server.

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

Remove-DeliveryAgentConnector

This cmdlet is available only in on-premises Exchange.

The Remove-DeliveryAgentConnector cmdlet removes a specific delivery agent connector configured in your organization.

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

Remove-EdgeSubscription

This cmdlet is available only in on-premises Exchange.

Use the Remove-EdgeSubscription cmdlet to remove Edge Subscription from the Exchange organization and from the subscribed Edge Transport server.

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

Remove-ForeignConnector

This cmdlet is available only in on-premises Exchange.

Use the Remove-ForeignConnector cmdlet to delete a Foreign connector in the Transport service of a Mailbox server.

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

Remove-InboundConnector

This cmdlet is available only in the cloud-based service.

Use the Remove-InboundConnector cmdlet to delete an Inbound connector from your cloud-based organization.

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

Remove-Message

This cmdlet is available only in on-premises Exchange.

Use the Remove-Message cmdlet to delete a message from a queue on a Mailbox server or an Edge Transport server.

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

Remove-OutboundConnector

This cmdlet is available only in the cloud-based service.

Use the Remove-OutboundConnector cmdlet to delete an Outbound connector from your cloud-based organization.

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

Remove-ReceiveConnector

This cmdlet is available only in on-premises Exchange.

Use the Remove-ReceiveConnector cmdlet to remove Receive connectors from Mailbox servers and Edge Transport servers.

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

Remove-RemoteDomain

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

Use the Remove-RemoteDomain cmdlet to remove a remote domain. When you remove a remote domain, the remote domain object is deleted. Removing a remote domain doesn't disable mail flow to that domain.

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

Remove-ResubmitRequest

This cmdlet is available only in on-premises Exchange.

Use the Remove-ResubmitRequest cmdlet to remove requests to replay redundant copies of messages from Safety Net after a mailbox database recovery.

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

Remove-RoutingGroupConnector

This cmdlet is available only in Exchange Server 2010.

Use the Remove-RoutingGroupConnector cmdlet to remove a routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group.

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

Remove-SendConnector

This cmdlet is available only in on-premises Exchange.

Use the Remove-SendConnector cmdlet to delete a Send connector.

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

Remove-SystemMessage

This cmdlet is available only in on-premises Exchange.

Use the Remove-SystemMessage cmdlet to remove custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages.

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

Remove-X400AuthoritativeDomain

This cmdlet is available only in on-premises Exchange.

Use the Remove-X400AuthoritativeDomain cmdlet to remove an X.400 authoritative domain. When you remove an X.400 authoritative domain, the X.400 authoritative domain object is deleted from Active Directory.

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

Resume-Message

This cmdlet is available only in on-premises Exchange.

Use the Resume-Message cmdlet to enable delivery of a previously suspended message in a queue on a Mailbox server or Edge Transport server.

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

Resume-Queue

This cmdlet is available only in on-premises Exchange.

Use the Resume-Queue cmdlet to restart processing for a suspended queue on a Mailbox server or an Edge Transport server.

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

Retry-Queue

This cmdlet is available only in on-premises Exchange.

Use the Retry-Queue cmdlet to force a connection attempt for a queue on a Mailbox server or an Edge Transport server.

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

Search-MessageTrackingReport

This cmdlet is functional only in on-premises Exchange.

Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see Get-MessageTrackingReport. The message tracking report cmdlets are used by the delivery reports feature.

In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets).

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

Set-AcceptedDomain

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

Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email.

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

Set-AddressRewriteEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.

Use the Set-AddressRewriteEntry cmdlet to modify an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server.

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

Set-DeliveryAgentConnector

This cmdlet is available only in on-premises Exchange.

Use the Set-DeliveryAgentConnector cmdlet to configure a specific delivery agent connector in your organization.

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

Set-EdgeSyncServiceConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-EdgeSyncServiceConfig cmdlet to modify the configuration of edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services.

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

Set-ForeignConnector

This cmdlet is available only in on-premises Exchange.

Use the Set-ForeignConnector cmdlet to modify an existing Foreign connector in the Transport service of a Mailbox server.

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

Set-FrontendTransportService

This cmdlet is available only in on-premises Exchange.

Use the Get-FrontEndTransportService cmdlet to modify the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed.

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

Set-InboundConnector

This cmdlet is available only in the cloud-based service.

Use the Set-InboundConnector cmdlet to change an existing Inbound connector in your cloud-based organization.

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

Set-MailboxTransportService

This cmdlet is available only in on-premises Exchange.

Use the Set-MailboxTransportService cmdlet to modify the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers.

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

Set-OutboundConnector

This cmdlet is available only in the cloud-based service.

Use the Set-OutboundConnector cmdlet to modify an existing Outbound connector in your cloud-based organization.

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

Set-ReceiveConnector

This cmdlet is available only in on-premises Exchange.

Use the Set-ReceiveConnector cmdlet to modify Receive connectors on Mailbox servers and Edge Transport servers.

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

Set-RemoteDomain

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

Use the Set-RemoteDomain cmdlet to configure a managed connection for a remote domain.

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

Set-ResubmitRequest

This cmdlet is available only in on-premises Exchange.

Use the Set-ResubmitRequest cmdlet to enable or disable requests to replay redundant copies of messages from Safety Net after a mailbox database recovery.

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

Set-RoutingGroupConnector

This cmdlet is available only in Exchange Server 2010.

Use the Set-RoutingGroupConnector cmdlet to modify the properties of an existing routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group. You can also use this cmdlet to configure the maximum message size that can pass across a routing group connector.

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

Set-SendConnector

This cmdlet is available only in on-premises Exchange.

Use the Set-SendConnector cmdlet to modify a Send connector.

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

Set-SystemMessage

This cmdlet is available only in on-premises Exchange.

Use the Set-SystemMessage cmdlet to modify custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages.

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

Set-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Set-TransportAgent cmdlet to modify existing transport agents.

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

Set-TransportConfig

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

Use the Set-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization.

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

Set-TransportServer

This cmdlet is available only in on-premises Exchange.

Use the Set-TransportServer cmdlet to modify settings that are associated with the Hub Transport server role or the Edge Transport server role.

Note: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService.

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

Set-TransportService

This cmdlet is available only in on-premises Exchange.

Use the Set-TransportService cmdlet to modify the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers.

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

Set-X400AuthoritativeDomain

This cmdlet is available only in on-premises Exchange.

Use the Set-X400AuthoritativeDomain cmdlet to edit an existing X.400 authoritative domain for your organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address.

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

Start-EdgeSynchronization

This cmdlet is available only in on-premises Exchange.

Use the Start-EdgeSynchronization cmdlet to immediately start synchronization of configuration data from Active Directory to the subscribed Edge Transport servers.

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

Start-HistoricalSearch

This cmdlet is available only in the cloud-based service.

Use the Start-HistoricalSearch cmdlet to start a new historical search.

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

Stop-HistoricalSearch

This cmdlet is available only in the cloud-based service.

Use the Stop-HistoricalSearch cmdlet to stop an existing historical search that has a status value of NotStarted.

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

Suspend-Message

This cmdlet is available only in on-premises Exchange.

Use the Suspend-Message cmdlet to prevent delivery of a particular message in a queue on a Mailbox server or an Edge Transport server.

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

Suspend-Queue

This cmdlet is available only in on-premises Exchange.

Use the Suspend-Queue cmdlet to stop processing for a queue on a Mailbox server or an Edge Transport server.

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

Test-EdgeSynchronization

This cmdlet is available only in on-premises Exchange.

Use the Test-EdgeSynchronization cmdlet to diagnose whether the subscribed Edge Transport servers have a current and accurate synchronization status.

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

Test-Mailflow

This cmdlet is available only in on-premises Exchange.

Use the Test-Mailflow cmdlet to diagnose whether mail can be successfully sent from and delivered to the system mailbox on a Mailbox server. You can also use this cmdlet to verify that email is sent between Mailbox servers within a defined latency threshold.

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

Test-SmtpConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-SmtpConnectivity cmdlet to diagnose whether an SMTP connection can successfully be established to the Receive connectors on a specific server. Although you can run this cmdlet manually to verify SMTP connectivity for a specified server, it's primarily used by Microsoft System Center Operations Manager 2007 to test your transport servers' ability to receive SMTP connections to each of the bindings on all the Receive connectors on those servers.

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

Uninstall-TransportAgent

This cmdlet is available only in on-premises Exchange.

Use the Uninstall-TransportAgent cmdlet to unregister transport agents from Exchange servers.

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

Validate-OutboundConnector

This cmdlet is available only in the cloud-based service.

Use the Validate-OutboundConnector cmdlet to test the settings of Outbound connectors in Microsoft 365.

Note: This cmdlet does not set the validation status or timestamp on the connector. To set these values, run the following command: Set-OutboundConnector -Identity "<ConnectorName>" -IsValidated $true -LastValidationTimestamp (Get-Date).ToUniversalTime().

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

mailbox-databases-and-servers

Clean-MailboxDatabase

This cmdlet is available only in Exchange Server 2010.

Use the Clean-MailboxDatabase cmdlet to scan Active Directory for disconnected mailboxes that aren't yet marked as disconnected in the Microsoft Exchange store and update the status of those mailboxes in the Exchange store. This cmdlet isn't able to update the Exchange store unless the Microsoft Exchange Information Store service is running and the database is mounted.

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

Disable-MailboxQuarantine

This cmdlet is available only in on-premises Exchange.

Use the Disable-MailboxQuarantine cmdlet to release quarantined mailboxes.

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

Disable-MetaCacheDatabase

This cmdlet is available only in on-premises Exchange.

Use the Disable-MetaCacheDatabase cmdlet to disable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons.

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

Dismount-Database

This cmdlet is available only in on-premises Exchange.

Use the Dismount-Database cmdlet to dismount databases. You can run this command only if the Microsoft Exchange Information Store service is running.

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

Enable-MailboxQuarantine

This cmdlet is available only in on-premises Exchange.

Use the Enable-MailboxQuarantine cmdlet to quarantine mailboxes that affect the availability of the mailbox database.

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

Enable-MetaCacheDatabase

This cmdlet is available only in on-premises Exchange.

Use the Enable-MetaCacheDatabase cmdlet to enable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons.

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

Get-FailedContentIndexDocuments

This cmdlet is functional only in Exchange Server 2016 or earlier.

Use the Get-FailedContentIndexDocuments cmdlet to retrieve a list of documents for a mailbox, mailbox database, or Mailbox server that couldn't be indexed by Exchange Search.

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

Get-MailboxDatabase

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxDatabase cmdlet to retrieve one or more mailbox database objects from a server or organization.

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

Get-MailboxRepairRequest

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxRepairRequest cmdlet to display information about current mailbox repair requests. Mailbox repair requests are created using the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruptions.

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

Get-MailboxServer

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxServer cmdlet to view information about Mailbox servers in your organization.

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

Get-SearchDocumentFormat

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

Use the Get-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search.

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

Get-StoreUsageStatistics

This cmdlet is available only in on-premises Exchange.

Use the Get-StoreUsageStatistics cmdlet to aid in diagnosing performance issues with your servers or databases.

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

Mount-Database

This cmdlet is available only in on-premises Exchange.

Use the Mount-Database cmdlet to mount mailbox databases on Exchange servers. The cmdlet mounts the database only if the Microsoft Exchange Information Store service and the Microsoft Exchange Replication service are running.

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

Move-DatabasePath

This cmdlet is available only in on-premises Exchange.

Use the Move-DatabasePath cmdlet to set a new path to the location of a database on the specified Mailbox server and to move the related files to that location.

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

New-MailboxDatabase

This cmdlet is available only in on-premises Exchange.

Use the New-MailboxDatabase cmdlet to create a mailbox database, or a recovery database. Each database you create must have a unique name in the organization.

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

New-MailboxRepairRequest

This cmdlet is available only in on-premises Exchange.

Use the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruption issues.

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

New-SearchDocumentFormat

This cmdlet is available only in on-premises Exchange.

Use the New-SearchDocumentFormat cmdlet to add a format-specific filter to those used by Exchange search.

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

Remove-MailboxDatabase

This cmdlet is available only in on-premises Exchange.

Use the Remove-MailboxDatabase cmdlet to delete a mailbox database object.

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

Remove-MailboxRepairRequest

This cmdlet is available only in on-premises Exchange.

Use the Remove-MailboxRepairRequest cmdlet to remove mailbox repair requests from a mailbox database that were created using the New-MailboxRepairRequest cmdlet.

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

Remove-SearchDocumentFormat

This cmdlet is available only in on-premises Exchange.

Use the Remove-SearchDocumentFormat cmdlet to remove a format-specific filter from those used by Exchange search. Only filters added with New-SearchDocumentFormat can be removed.

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

Remove-StoreMailbox

This cmdlet is available only in on-premises Exchange.

Use the Remove-StoreMailbox cmdlet to purge the mailbox and all of its message content from the mailbox database. This results in permanent data loss for the mailbox being purged. You can only run this cmdlet against disconnected or soft-deleted mailboxes. Running this command against an active mailbox fails, and you receive an error.

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

Set-MailboxDatabase

This cmdlet is available only in on-premises Exchange.

Use the Set-MailboxDatabase cmdlet to configure a variety of properties for a mailbox database.

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

Set-MailboxServer

This cmdlet is available only in on-premises Exchange.

Use the Set-MailboxServer cmdlet to modify the mailbox configuration settings and attributes of Mailbox servers.

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

Set-SearchDocumentFormat

This cmdlet is available only in on-premises Exchange.

Use the Set-SearchDocumentFormat cmdlet to enable or disable the file format for Exchange Search.

When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Outlook on the web, Microsoft Outlook in online mode and In-Place eDiscovery.

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

Start-MailboxAssistant

This cmdlet is available only in Exchange Server 2019 in Cumulative Update 11 (CU11) or later.

Use the Start-MailboxAssistant cmdlet to start processing of a mailbox by the specified assistant.

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

Test-AssistantHealth

This cmdlet is available only in on-premises Exchange.

Use the Test-AssistantHealth cmdlet to verify that the Microsoft Exchange Mailbox Assistants service (MSExchangeMailboxAssistants) is healthy, to recover from health issues, and to report the status of the diagnosis or recovery action.

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

Test-ExchangeSearch

This cmdlet is available only in on-premises Exchange.

Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new email messages in a timely manner.

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

Test-MRSHealth

This cmdlet is available only in on-premises Exchange.

Use the Test-MRSHealth cmdlet to test the health of an instance of the Microsoft Exchange Mailbox Replication service.

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

Update-DatabaseSchema

This cmdlet is available only in on-premises Exchange.

Use the Update-DatabaseSchema cmdlet to upgrade the database schema for one or more databases after an Exchange software update that includes database schema updates has been installed on Mailbox servers in a database availability group (DAG). Some software updates for Exchange may include database schema updates. After such an update has been installed on all members of a DAG, the administrator must run the Update-DatabaseSchema cmdlet for each database in the DAG and dismount/mount or failover the database to trigger the database schema update. The in-place database schema upgrade engine ensures that no schema updates occur until all members of the DAG have compatible versions of the software.

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

Update-FileDistributionService

This cmdlet is available only in Exchange Server 2010.

Use the Update-FileDistributionService cmdlet to access the Microsoft Exchange File Distribution service to poll for offline address book (OAB), Group Metrics, and Unified Messaging (UM) configuration and data.

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

Update-StoreMailboxState

This cmdlet is available only in on-premises Exchange.

Use the Update-StoreMailboxState cmdlet to synchronize the mailbox state for a mailbox in the Exchange mailbox store with the state of the corresponding Active Directory user account.

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

mailboxes

Add-MailboxFolderPermission

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

Use the Add-MailboxFolderPermission cmdlet to add folder-level permissions for users in mailboxes.

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

Add-MailboxPermission

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

Use the Add-MailboxPermission cmdlet to add permissions to a mailbox or to an Exchange Server 2016, Exchange Server 2019, or Exchange Online mail user.

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

Add-RecipientPermission

This cmdlet is available only in the cloud-based service.

Use the Add-RecipientPermission cmdlet to add SendAs permission to users in a cloud-based organization.

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

Connect-Mailbox

This cmdlet is available only in on-premises Exchange.

Use the Connect-Mailbox cmdlet to connect disconnected mailboxes to existing user accounts that don't already have mailboxes.

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

Disable-App

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

Use the Disable-App cmdlet to disable (turn off) a specific app for a specific user.

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

Disable-InboxRule

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

Use the Disable-InboxRule cmdlet to disable existing Inbox rules in mailboxes.

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

Disable-Mailbox

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

Use the Disable-Mailbox cmdlet to disable the mailbox of existing users who already have mailboxes. For this cmdlet, a user could also be a public folder mailbox or an InetOrgPerson object. The user account that's associated with the mailbox remains, but it's no longer associated with a mailbox.

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

Disable-ServiceEmailChannel

This cmdlet is available only in on-premises Exchange.

Use the Disable-ServiceEmailChannel cmdlet to disable the .NET service channel for a specific user. The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange.

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

Disable-SweepRule

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

Use the Disable-SweepRule cmdlet to disable Sweep rules in mailboxes.

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

Enable-App

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

Use the Enable-App cmdlet to enable (turn on) a specific app for a specific user.

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

Enable-InboxRule

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

Use the Enable-InboxRule cmdlet to enable an Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message.

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

Enable-Mailbox

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

Use the Enable-Mailbox cmdlet to create mailboxes for existing users who don't already have mailboxes. You can also use this cmdlet to create In-Place archives for existing mailboxes.

Note: In Exchange Online, you use this cmdlet to add archive mailboxes for existing users and to enable auto-expanding archives. To add a mailbox for an existing Microsoft Entra account, you need to add a license to the account as described in Assign licenses to user accounts.

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

Enable-ServiceEmailChannel

This cmdlet is available only in on-premises Exchange.

Use the Enable-ServiceEmailChannel cmdlet to enable the .NET service channel for a specific user.

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

Enable-SweepRule

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

Use the Enable-SweepRule cmdlet to enable Sweep rules in mailboxes.

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

Expedite-Delicensing

This cmdlet is available only in the cloud-based service.

Use the Expedite-Delicensing cmdlet to end the delay for removing mailbox licenses from users. After you remove the delay, the licenses are removed from mailboxes within 24 hours. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet.

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

Export-MailboxDiagnosticLogs

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

Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in your organization.

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

Export-RecipientDataProperty

This cmdlet is available only in on-premises Exchange.

Use the Export-RecipientDataProperty cmdlet to download the picture or spoken name audio file of a mailbox or mail contact.

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

Get-App

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

Use the Get-App cmdlet to view installed apps.

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

Get-CalendarDiagnosticAnalysis

Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in on-premises Exchange.

Use the Get-CalendarDiagnosticAnalysis cmdlet to troubleshoot calendar-related reliability issues. You can use this cmdlet to analyze calendar item data that's recorded in the Calendar Diagnostic logs. You provide the calendar item data to this cmdlet by using the Get-CalendarDiagnosticLog cmdlet.

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

Get-CalendarDiagnosticLog

Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in on-premises Exchange. In cloud-based service, use the Get-CalendarDiagnosticObjects cmdlet instead.

Use the Get-CalendarDiagnosticLog cmdlet to collect a range of calendar logs. The Calendar Diagnostic logs track all calendar items and meeting requests in mailboxes. You can use this information to troubleshoot calendar issues that occur in mailboxes.

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

Get-CalendarDiagnosticObjects

This cmdlet is available only in the cloud-based service.

Use the Get-CalendarDiagnosticObjects cmdlet to collect a range of calendar logs. The calendar diagnostic logs track important calendar-related event data for each mailbox, and can be used to troubleshoot calendar issues that occur in mailboxes. The logs track all calendar items and meeting messages.

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

Get-CalendarNotification

This cmdlet is available only in on-premises Exchange.

Use the Get-CalendarNotification cmdlet to view calendar text message notification settings for a mailbox.

Note: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365.

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

Get-CalendarProcessing

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

Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. Note that the settings returned by this cmdlet are editable only on resource mailboxes.

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

Get-Clutter

This cmdlet is available only in the cloud-based service.

Use the Get-Clutter cmdlet to view Clutter settings for mailboxes in your organization.

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

Get-EventsFromEmailConfiguration

This cmdlet is available only in the cloud-based service.

Use the Get-EventsFromEmailConfiguration cmdlet to view the events from email settings on a mailbox. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar.

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

Get-ExternalInOutlook

This cmdlet is available only in the cloud-based service.

Use the Get-ExternalInOutlook cmdlet to view the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android.

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

Get-FocusedInbox

This cmdlet is available only in the cloud-based service.

Use the Get-FocusedInbox cmdlet to view the Focused Inbox configuration for mailboxes in your organization.

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

Get-InboxRule

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

Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message.

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

Get-Mailbox

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

Use the Get-Mailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailbox cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

Get-MailboxAutoReplyConfiguration

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

Use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve Automatic Replies settings for a specific mailbox.

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

Get-MailboxCalendarFolder

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

Use the Get-MailboxCalendarFolder cmdlet to retrieve the publishing or sharing settings for a specified mailbox calendar folder.

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

Get-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxExportRequest cmdlet to view the detailed status of an ongoing export request that was initiated by using the New-MailboxExportRequest cmdlet.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-MailboxExportRequestStatistics

This cmdlet is available only in on-premises Exchange.

Use the Get-MailboxExportRequestStatistics cmdlet to view detailed information about export requests.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-MailboxFolder

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

Use the Get-MailboxFolder cmdlet to view folders in your own mailbox. Administrators can't use this cmdlet to view folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role).

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

Get-MailboxFolderPermission

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

Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderPermission cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

Get-MailboxFolderStatistics

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

Use the Get-MailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderStatistics cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

Get-MailboxImportRequest

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

Use the Get-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-MailboxImportRequestStatistics

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

Use the Get-MailboxImportRequestStatistics cmdlet to view detailed information about import requests.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

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

Get-MailboxLocation

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

Use the Get-MailboxLocation cmdlet to view mailbox location information in Exchange Online.

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

Get-MailboxPermission

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

Use the Get-MailboxPermission cmdlet to retrieve permissions on a mailbox.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxPermission cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

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

Get-MailboxPlan

This cmdlet is available only in the cloud-based service.

Use the Get-MailboxPlan cmdlet to view information about mailbox plans in the cloud-based service.

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

Get-MailboxRestoreRequest

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

Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxRestoreRequestStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxSentItemsConfiguration

This cmdlet is available only in Exchange Server 2010.

Use the Get-MailboxSentItemsConfiguration cmdlet to view the Sent Items settings on mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. In addition, you can get the move history or a move report of a completed move request.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxStatistics cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxUserConfiguration

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxUserConfiguration cmdlet to view user configuration items in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MessageCategory

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MessageCategory cmdlet to retrieve a message category from the specified mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PendingDelicenseUser

This cmdlet is available only in the cloud-based service.

Use the Get-PendingDelicenseUser cmdlet to view information about mailboxes that have delayed mailbox license removal requests. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Place

This cmdlet is available only in the cloud-based service.

Use the Get-Place cmdlet to view the additional metadata that was configured on room mailboxes by using the Set-Place cmdlet. The additional metadata provides a better search and room suggestion experience.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RecipientPermission

This cmdlet is available only in the cloud-based service.

Use the Get-RecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization.

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipientPermission cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RecoverableItems

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RecoverableItems items cmdlet to view deleted items in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ResourceConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ResourceConfig cmdlet to view custom room and equipment mailbox properties that you've configured by using the Set-ResourceConfig cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SweepRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UserPhoto

This cmdlet is available only in on-premises Exchange.

Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint.

Note: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see Manage user photos in Microsoft Graph PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-RecipientDataProperty

Use the Import-RecipientDataProperty cmdlet to add a picture or a spoken name audio file to a mailbox or mail contact.

Note: Profile cards across Microsoft apps and services don't support imported pictures for mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-App

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-App cmdlet to install apps for Outlook.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-InboxRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-InboxRule cmdlet to create Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions and take actions such as moving a message to a specified folder or deleting a message.

You must have adequate permissions on the mailbox to create an Inbox rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-Mailbox

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the New-MailboxExportRequest cmdlet to begin the process of exporting contents of a primary mailbox or archive to a .pst file.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailboxFolder cmdlet to create folders in your own mailbox. Administrators can't use this cmdlet to create folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxImportRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailboxImportRequest cmdlet to begin the process of importing a .pst file to a mailbox or archive.

Note: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see Use network upload to import PST files.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxRestoreRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailboxRestoreRequest cmdlet to restore a soft-deleted or disconnected mailbox. This cmdlet starts the process of moving content from the soft-deleted mailbox, disabled mailbox, or any mailbox in a recovery database into a connected primary or archive mailbox.

The properties used to find disconnected mailboxes and restore a mailbox are different in Exchange Server and Exchange Online. For more information about Exchange Online, see Restore an inactive mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailMessage

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SiteMailbox

This cmdlet is available only in on-premises Exchange.

The New-SiteMailbox cmdlet is used by the Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SweepRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-App

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-App cmdlet to uninstall an app.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-CalendarEvents

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-CalendarEvents cmdlet to cancel future meetings in user or resource mailboxes. Cancelling future meetings removes them from attendee and resource calendars (for example, you're going to remove the mailbox, or the user is going on a leave of absence).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-InboxRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-InboxRule cmdlet to remove an Inbox rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-Mailbox

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-Mailbox cmdlet to delete mailboxes and the associated user accounts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the Remove-MailboxExportRequest cmdlet to remove fully or partially completed export requests. You can create multiple export requests for a specified mailbox provided that you specify a distinct name. Completed export requests aren't cleared automatically; they need to be removed by using this cmdlet.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

When a partially completed export request is removed, content already exported isn't removed from the PST file. If you want to start a new export request to the same file name and start with an empty PST file, you need to rename or delete the previous PST file.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxFolderPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxFolderPermission cmdlet to remove folder-level permissions for users in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxImportRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxImportRequest cmdlet to remove fully or partially completed import requests. Completed import requests aren't automatically cleared. Requests need to be removed by using the Remove-MailboxImportRequest cmdlet. Multiple import requests can exist against the same mailbox if you provide a distinct import request name.

NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see Use network upload to import PST files.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress that was made until the removal won't be reverted.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox or from an Exchange Server 2016, Exchange Server 2019 or Exchange Online mail user.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxRestoreRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxRestoreRequest cmdlet to remove fully or partially completed restore requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxUserConfiguration

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxUserConfiguration cmdlet to remove user configuration items from mailboxes. Typically, after you delete a user configuration item, it's automatically recreated the next time the user uses that feature in their mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RecipientPermission

This cmdlet is available only in the cloud-based service.

Use the Remove-RecipientPermission cmdlet to remove SendAs permission from users in a cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SweepRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-SweepRule cmdlet to remove Sweep rules from mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UserPhoto

This cmdlet is available only in on-premises Exchange.

Use the Remove-UserPhoto cmdlet to delete the photo associated with a user's account. The user photo feature allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint.

Note: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see Manage user photos in Microsoft Graph PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Restore-Mailbox

This cmdlet is available only in Exchange Server 2010.

Use the Restore-Mailbox cmdlet to extract mailbox content from a restored database.

Note: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Restore-RecoverableItems

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Restore-RecoverableItems items cmdlet to restore deleted items in mailboxes. You use the Get-RecoverableItems cmdlet to find the deleted items to recover.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the Resume-MailboxExportRequest cmdlet to resume an export request that was suspended or failed.

This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-MailboxImportRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Resume-MailboxImportRequest cmdlet to resume an import request that was suspended or failed.

NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see Use network upload to import PST files.

This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-MailboxRestoreRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Resume-MailboxRestoreRequest cmdlet to resume a restore request that was suspended or failed.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Search-Mailbox

This cmdlet is available only in on-premises Exchange.

Use the Search-Mailbox cmdlet to search a mailbox and copy the results to a specified target mailbox, delete messages from the source mailbox, or both.

Note: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of New-ComplianceSearch and related eDiscovery cmdlets.

By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to any role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-App

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-App cmdlet to modify the availability of organization apps.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CalendarNotification

This cmdlet is available only in on-premises Exchange.

The Set-CalendarNotification cmdlet allows users to set text message notification options for calendar events in their own calendar. By default, the MyTextMessaging end-user role gives access to this cmdlet, so admins can't configure text messaging notification for calendar events in user calendars.

Note: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CalendarProcessing

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. Note that this cmdlet is effective only on resource mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Clutter

This cmdlet is available only in the cloud-based service.

Use the Set-Clutter cmdlet to configure Clutter settings for mailboxes in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-EventsFromEmailConfiguration

This cmdlet is available only in the cloud-based service.

Use the Set-EventsFromEmailConfiguration cmdlet to modify the events from email settings on a mailbox. on Outlook clients and Outlook on the web. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ExternalInOutlook

This cmdlet is available only in the cloud-based service.

Use the Set-ExternalInOutlook cmdlet to modify the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FocusedInbox

This cmdlet is available only in the cloud-based service.

Use the Set-FocusedInbox cmdlet to enable or disable Focused Inbox for mailboxes in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-InboxRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-InboxRule cmdlet to modify existing Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Mailbox

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-Mailbox cmdlet to modify the settings of existing mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxAutoReplyConfiguration

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxCalendarFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxCalendarFolder cmdlet to configure calendar publishing or sharing settings on a mailbox for the visibility of calendar information to external users. To add or modify the permissions so internal users can access the calendar, use the Add-MailboxFolderPermission or Set-MailboxFolderPermission cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the Set-MailboxExportRequest cmdlet to change export request options after the request has been created. You can use the Set-MailboxExportRequest cmdlet to recover from failed export requests.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxFolderPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxFolderPermission cmdlet to modify folder-level permissions for users in mailboxes. This cmdlet differs from the Add-MailboxFolderPermission cmdlet in that it modifies existing permission entries. To configure calendar publishing or sharing settings for a mailbox so calendar information is visible to external users, use the Set-MailboxCalendarFolder cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxImportRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxImportRequest cmdlet to change import request options after the request has been created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxPlan

This cmdlet is available only in the cloud-based service.

Use the Set-MailboxPlan cmdlet to modify the settings of mailbox plans in the cloud-based service.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxRestoreRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request has been created. You can use this cmdlet to recover from failed restore requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxSentItemsConfiguration

This cmdlet is available only in Exchange Server 2010.

Use the Set-MailboxSentItemsConfiguration cmdlet to modify the Sent Items settings for mailboxes in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Place

This cmdlet is available only in the cloud-based service.

Use the Set-Place cmdlet to update room mailboxes with additional metadata, which provides a better search and room suggestion experience.

Note: In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, or Street. To modify these properties (except GeoCoordinates on synchronized room mailboxes), use the Set-User or Set-Mailbox cmdlets in on-premises Exchange.

Note: We recommend using this cmdlet with the EXO V3 module. Commands using Set-Place to change certain combinations of properties together can fail in older versions of the module. For more information about the EXO V3 module, see About the Exchange Online PowerShell module.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ResourceConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ResourceConfig cmdlet to create custom resource properties that you can add to room and equipment mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SweepRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-SweepRule cmdlet to modify Sweep rules in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UserPhoto

This cmdlet is available only in on-premises Exchange.

Use the Set-UserPhoto cmdlet to configure the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint.

Note: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see Manage user photos in Microsoft Graph PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-MailboxExportRequest

This cmdlet is available only in on-premises Exchange.

Use the Suspend-MailboxExportRequest cmdlet to suspend an export request any time after the request was created, but before the request reaches the status of Completed. You can resume the request by using the Resume-MailboxExportRequest cmdlet.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-MailboxImportRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Suspend-MailboxImportRequest cmdlet to suspend an import request any time after the request was created, but before the request reaches the status of Completed. You can resume the move request by using the Resume-MailboxImportRequest cmdlet.

NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see Use network upload to import PST files.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-MailboxRestoreRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Suspend-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-MAPIConnectivity

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-MapiConnectivity cmdlet to verify server functionality by logging on to the mailbox that you specify. If you don't specify a mailbox, the cmdlet logs on to the SystemMailbox on the database that you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Undo-SoftDeletedMailbox

This cmdlet is available only in the cloud-based service.

Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been deleted. Mailboxes can be recovered within 30 days of being deleted.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

move-and-migration

Complete-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-MigrationReport

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

The Export-MigrationReport is used by the Exchange migration process to enable an administrator to download a CSV file that contains migration errors for a selected migration batch. This cmdlet isn't run by an administrator in Windows PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationBatch cmdlet to retrieve status information about the current migration batch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationConfig cmdlet to retrieve migration configuration settings on Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationEndpoint

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationStatistics cmdlet to view detailed information about migration requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationUser cmdlet to view information about move and migration users.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MigrationUserStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MigrationUserStatistics cmdlet to view detailed information about the migration requested for a specific user.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MoveRequestStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MoveRequestStatistics cmdlet to view detailed information about move requests.

Some of the failure messages that are returned by this cmdlet are temporary and don't indicate that a request has actually failed. If the Status value is Queued or InProgress, then the request is proceeding normally.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMailboxMigrationRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMailboxMigrationRequest cmdlet to view the status of individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMailboxMigrationRequestStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the Get-PublicFolderMigrationRequest cmdlet to view information about serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet).

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMigrationRequestStatistics

This cmdlet is available only in on-premises Exchange.

Use the Get-PublicFolderMigrationRequestStatistics cmdlet to view detailed information about serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet).

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMoveRequest cmdlet to view the detailed status of an ongoing public folder move that was initiated using the New-PublicFolderMoveRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMoveRequestStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMoveRequestStatistics cmdlet to view detailed information about public folder move requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MigrationBatch cmdlet to submit a new migration request for a batch of users.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MigrationEndpoint

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MigrationEndpoint cmdlet to configure the connection settings for cross-forests moves, remote move migrations, cutover or staged Exchange migrations, IMAP migrations, and Google Workspace (formerly G Suite) migrations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MoveRequest cmdlet to begin the process of an asynchronous mailbox or personal archive move. You can also check mailbox readiness to be moved by using the WhatIf parameter.

Note: After April 15, 2020, you shouldn't use this cmdlet to manually move mailboxes within an Exchange Online organization. You can only use this cmdlet for migrating to and from Exchange Online. If you have issues with a mailbox and want to fix it by moving the mailbox within your Exchange Online organization, please open a Microsoft Support request instead.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the New-PublicFolderMigrationRequest cmdlet to start a serial public folder migration from Exchange Server 2010.

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PublicFolderMoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request.

Be aware that the target public folder mailbox will be locked while the move request is active. For more information, see the Description section.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or has been completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MigrationEndpoint

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MigrationEndpoint cmdlet to remove existing migration endpoints for source or destination servers for cutover or staged Exchange migrations, IMAP migrations and remote moves.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MigrationUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MigrationUser cmdlet to remove a migration user from a batch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderMailboxMigrationRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PublicFolderMailboxMigrationRequest cmdlet to remove individual jobs from public folder migration batches that were created by using the New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the Remove-PublicFolderMigrationRequest cmdlet to cancel or complete serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You need to use this cmdlet to remove an existing serial public folder migration request before you can create another one.

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderMoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PublicFolderMoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. After the move has been finalized, you can't undo the move request.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Resume-MoveRequest cmdlet to resume a move request that has been suspended or has failed.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the Resume-PublicFolderMigrationRequest cmdlet to resume serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet) that have failed or have been suspended (manually or automatically).

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-PublicFolderMoveRequest

This cmdlet is available only in on-premises Exchange.

Use the Resume-PublicFolderMoveRequest cmdlet to resume a public folder move request that has been suspended or has failed.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see New-MigrationBatch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MigrationConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MigrationConfig cmdlet to edit migration configurations on Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MigrationEndpoint

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations, Google Workspace (formerly G Suite) migrations, and remote moves.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MigrationUser

This cmdlet is functional only in the cloud-based service.

Use the Set-MigrationUser cmdlet to modify the migration settings of a user in an existing migration batch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the Set-PublicFolderMigrationRequest cmdlet to modify serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You can use this cmdlet to recover from failed migration requests.

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PublicFolderMoveRequest

This cmdlet is available only in on-premises Exchange.

Use the Set-PublicFolderMoveRequest cmdlet to change a public folder move request after the move request has been created. You can use the Set-PublicFolderMoveRequest cmdlet to recover from a failed move request.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Start-MigrationBatch cmdlet to start a move request or migration batch that was created with the New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-MigrationUser

This cmdlet is functional only in the cloud-based service.

Use the Start-MigrationUser cmdlet to start the migration of a user in an existing migration batch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-MigrationBatch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-MigrationUser

This cmdlet is functional only in the cloud-based service.

Use the Stop-MigrationUser cmdlet to stop the migration of a user in an existing migration batch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-MoveRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Suspend-MoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-MoveRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-PublicFolderMailboxMigrationRequest

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Suspend-PublicFolderMailboxMigrationRequest cmdlet to suspend individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-PublicFolderMigrationRequest

This cmdlet is available only in on-premises Exchange.

Use the Suspend-PublicFolderMigrationRequest cmdlet to suspend serial public folder migration requests (requests created by the New-PublicFolderMigrationRequest cmdlet). You can suspend active requests before they reach the status CompletionInProgress. You resume suspended requests by using the Resume-PublicFolderMigrationRequest cmdlet.

Note: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding *-MigrationBatch and *-PublicFolderMailboxMigration* cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-PublicFolderMoveRequest

This cmdlet is available only in on-premises Exchange.

Use the Suspend-PublicFolderMoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-PublicFolderMoveRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-MigrationServerAvailability

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

organization

Disable-CmdletExtensionAgent

This cmdlet is available only in on-premises Exchange.

Use the Disable-CmdletExtensionAgent cmdlet to disable existing cmdlet extension agents.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-CmdletExtensionAgent

This cmdlet is available only in on-premises Exchange.

Use the Enable-CmdletExtensionAgent cmdlet to enable existing cmdlet extension agents.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-OrganizationCustomization

This cmdlet is available only in the cloud-based service.

You may be prompted to run the EnableOrganizationCustomization cmdlet before you create or modify objects in your Exchange Online organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AccessToCustomerDataRequest

This cmdlet is available only in the cloud-based service.

Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 Customer Lockbox requests that control access to your data by Microsoft support engineers.

Note: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ApplicationAccessPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-ApplicationAccessPolicy cmdlet to view the list of application access policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuthConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-AuthConfig cmdlet to get the authorization configuration for partner applications.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuthenticationPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AuthenticationPolicy cmdlet to view authentication policies in your organization. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuthServer

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AuthServer cmdlet to view the settings of authorization servers in the Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-CmdletExtensionAgent

This cmdlet is available only in on-premises Exchange.

Use the Get-CmdletExtensionAgent cmdlet to view cmdlet extension agents.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeAssistanceConfig

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeAssistanceConfig cmdlet to view the configuration information for the URLs that Microsoft Exchange Help uses to connect to the source of the documentation.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeDiagnosticInfo

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeDiagnosticInfo cmdlet to return information about processes that are running on Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeServer

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeServer cmdlet to view the properties of Exchange servers.

When you run the Get-ExchangeServer cmdlet with no parameters, it returns the attributes of all the servers in the Exchange organization. To return specific server properties (including domain controller information) where the Get-ExchangeServer cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the Status parameter.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeServerAccessLicense

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeServerAccessLicense cmdlet to return a list of licenses in use in your Exchange organization. This refers to the specific legal name of the license, as defined in the Microsoft Product List and is representative of your licenses when you run this cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeServerAccessLicenseUser

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeServerAccessLicenseUser cmdlet to return a list of unique users for the specified license name. Each object contains the FQDN or primary SMTP address of the mailbox and the license that's associated with it.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExchangeSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeSettings cmdlet to view customized Exchange setting objects that are stored in Active Directory. Use the New-ExchangeSettings to create the settings object, and the Set-ExchangeSettings cmdlet to define the actual settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Notification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-Notification cmdlet to view notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events:

  • Mailbox moves and migrations.
  • Expiring and expired certificates.
  • Exporting mailbox content to .pst files.
  • Importing mailbox content from .pst files.
  • Restoring deleted mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OrganizationConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PartnerApplication

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PartnerApplication cmdlet to retrieve settings for a partner application.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PerimeterConfig

This cmdlet is available only in the cloud-based service.

Use the Get-PerimeterConfig cmdlet to view the list of gateway server and internal mail server IP addresses that have been added to the cloud-based safelists.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ServicePrincipal

This cmdlet is available only in the cloud-based service.

Use the Get-ServicePrincipal cmdlet to view information about service principals in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SettingOverride

This cmdlet is available only in on-premises Exchange.

Caution: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support.

Use the Get-SettingOverride cmdlet to view existing setting overrides that store Exchange customizations in Active Directory instead of in text files on the server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ApplicationAccessPolicy

This cmdlet is available only in the cloud-based service.

Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access to a specific set of mailboxes by an application that uses APIs (Outlook REST, Microsoft Graph, or Exchange Web Services (EWS)). These policies are complementary to the permission scopes that are declared by the application.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Note: App Access Policies will soon be replaced by Roles Based Access Control for Applications. To learn more, see Roles Based Access Control for Exchange Applications.

New-AuthenticationPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-AuthenticationPolicy cmdlet to create authentication policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AuthServer

This cmdlet is available only in on-premises Exchange.

Use the New-AuthServer cmdlet to create an authorization server object in Microsoft Exchange and specify its AuthMetadataUrl. Exchange honors tokens issued by the authorization server for access by a partner application.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ExchangeSettings

This cmdlet is available only in on-premises Exchange.

Use the New-ExchangeSettings cmdlet to create customized Exchange setting objects that are stored in Active Directory. Use the Set-ExchangeSettings cmdlet to configure the actual settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PartnerApplication

This cmdlet is functional only in on-premises Exchange.

Use the New-PartnerApplication cmdlet to create partner application configurations in on-premises Exchange organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ServicePrincipal

This cmdlet is available only in the cloud-based service.

Use the New-ServicePrincipal cmdlet to create service principals in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SettingOverride

This cmdlet is available only in on-premises Exchange.

Caution: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support.

Use the New-SettingOverride cmdlet to create setting overrides that store Exchange customizations in Active Directory instead of in text files on the server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ApplicationAccessPolicy

This cmdlet is available only in the cloud-based service.

Use the Remove-ApplicationAccessPolicy cmdlet to remove application access policies. These changes may take up to 30 minutes to go live.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AuthenticationPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-AuthenticationPolicy cmdlet to remove authentication policies from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AuthServer

This cmdlet is available only in on-premises Exchange.

Use the Remove-AuthServer cmdlet to remove an authorization server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PartnerApplication

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PartnerApplication cmdlet to remove a partner application configuration.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ServicePrincipal

This cmdlet is available only in the cloud-based service.

Use the Remove-ServicePrincipal cmdlet to remove service principals from your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SettingOverride

This cmdlet is available only in on-premises Exchange.

Caution: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support.

Use the Remove-SettingOverride cmdlet to remove setting overrides from Active Directory.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AccessToCustomerDataRequest

This cmdlet is available only in the cloud-based service.

Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers.

Note: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ApplicationAccessPolicy

This cmdlet is available only in the cloud-based service.

Use the Set-ApplicationAccessPolicy cmdlet to modify the description of an application access policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AuthConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-AuthConfig cmdlet to modify the authorization configuration for your Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AuthenticationPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-AuthenticationPolicy cmdlet to modify authentication policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AuthServer

This cmdlet is available only in on-premises Exchange.

Use the Set-AuthServer cmdlet to configure an authorization server that partner applications can use to obtain tokens recognized by Microsoft Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CmdletExtensionAgent

This cmdlet is available only in on-premises Exchange.

Use the Set-CmdletExtensionAgent cmdlet to modify cmdlet extension agents. To enable or disable cmdlet extension agents, use the Enable-CmdletExtensionAgent and Disable-CmdletExtensionAgent cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ExchangeAssistanceConfig

This cmdlet is available only in on-premises Exchange.

Use the Set-ExchangeAssistanceConfig cmdlet to modify the Microsoft Exchange Help configurations for your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ExchangeServer

This cmdlet is available only in on-premises Exchange.

Use the Set-ExchangeServer cmdlet to set Exchange attributes in Active Directory for a specified server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ExchangeSettings

This cmdlet is available only in on-premises Exchange.

Use the Set-ExchangeSettings cmdlet to configure Exchange setting objects that you created with the New-ExchangeSettings cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Notification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events:

  • Mailbox moves and migrations.
  • Expiring and expired certificates.
  • Exporting mailbox content to .pst files.
  • Importing mailbox content from .pst files.
  • Restoring deleted mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-OrganizationConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PartnerApplication

This cmdlet is functional only in on-premises Exchange.

Use the Set-PartnerApplication cmdlet to configure partner application configurations in on-premises Exchange organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PerimeterConfig

This cmdlet is available only in the cloud-based service.

Use the Set-PerimeterConfig cmdlet to modify the list of gateway server IP addresses that have been added to the cloud-based safelists.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ServicePrincipal

This cmdlet is available only in the cloud-based service.

Use the Set-ServicePrincipal cmdlet to change service principals in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SettingOverride

This cmdlet is available only in on-premises Exchange.

Caution: Incorrect usage of the setting override cmdlets can cause serious damage to your Exchange organization. This damage could require you to reinstall Exchange. Only use these cmdlets as instructed by product documentation or under the direction of Microsoft Customer Service and Support.

Use the Set-SettingOverride cmdlet to modify setting overrides that store Exchange customizations in Active Directory instead of in text files on the server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-ApplicationAccessPolicy

This cmdlet is available only in the cloud-based service.

Use the Test-ApplicationAccessPolicy cmdlet to test access right of an application to a specific user/mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-OAuthConnectivity

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-ServicePrincipalAuthorization

This cmdlet is available only in the cloud-based service.

Use the Test-ServicePrincipalAuthorization cmdlet to test the access granted by role-based access control (RBAC) for Applications. For more information, see Role Based Access Control for Applications in Exchange Online.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-SystemHealth

This cmdlet is available only in Exchange Server 2010.

Use the Test-SystemHealth cmdlet to gather data about your Microsoft Exchange system and to analyze the data according to best practices.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-ExchangeHelp

This cmdlet is available only in on-premises Exchange.

Use the Update-ExchangeHelp cmdlet to find, download and install the latest available help topics for the Exchange Management Shell on the local computer. If an available version is found based your installed version and languages of Exchange, the cmdlet downloads and integrates the updated version of Help in the Exchange Management Shell. This cmdlet is a required substitute for the Update-Help cmdlet that's available in Windows PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

policy-and-compliance

Disable-JournalArchiving

This cmdlet is available only in the cloud-based service.

Use the Disable-JournalArchiving cmdlet to disable journal archiving for specific users. Microsoft 365 journal archiving uses mailboxes in Exchange Online to record or journal messages for mailboxes in on-premises organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Disable-JournalRule cmdlet to disable a journal rule on a Mailbox server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Disable-OutlookProtectionRule cmdlet to disable an existing Microsoft Outlook protection rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Disable-TransportRule cmdlet to disable transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Enable-JournalRule cmdlet to enable an existing journal rule on a Mailbox server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Enable-OutlookProtectionRule cmdlet to enable an existing Outlook protection rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Enable-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Execute-AzureADLabelSync

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Execute-AzureADLabelSync cmdlet to start the synchronization of sensitivity labels into Microsoft Entra ID. This allows the application of sensitivity labels to Microsoft Teams sites, Microsoft 365 Groups, and SharePoint sites. This cmdlet is required if you were using sensitivity labels before September 2019.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-JournalRuleCollection

This cmdlet is available only in on-premises Exchange.

Use the Export-JournalRuleCollection cmdlet to export the journal rules in your organization to an XML file.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-TransportRuleCollection

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ActivityAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note: Activity alerts have been effectively replaced by alert policies and the corresponding *-ProtectionAlert cmdlets. For more information about alert policies, see Alert policies in Microsoft 365.

Use the Get-ActivityAlert cmdlet to view activity alerts. Activity alerts send email notifications when users perform specific activities in Microsoft 365.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AdministrativeUnit

This cmdlet is functional only in the cloud-based service.

Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Microsoft Entra containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users.

Note: Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AutoSensitivityLabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AutoSensitivityLabelRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policy rules in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EtrLimits

This cmdlet is available only in the cloud-based service.

Use the Get-EtrLimits cmdlet to show information about mail flow rule (also known as transport rule) limits in Exchange Online, as well the current usage and the largest rule IDs in terms of size and regular expression character count.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExoInformationBarrierPolicy

This cmdlet is available only in the cloud-based service.

Use the Get-ExoInformationBarrierPolicy cmdlet to view information barrier policies in your Exchange Online organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExoInformationBarrierRelationship

This cmdlet is available only in the cloud-based service.

Use the Get-ExoInformationBarrierRelationship cmdlet to view information barrier relationships in your Exchange Online organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ExoInformationBarrierSegment

This cmdlet is available only in the cloud-based service.

Use the Get-ExoInformationBarrierSegment to view information barrier segments in your Exchange Online organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-InformationBarrierPoliciesApplicationStatus

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-InformationBarrierPoliciesApplicationStatus cmdlet to view the application status of information barrier policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-InformationBarrierPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-InformationBarrierPolicy cmdlet to view information barrier policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-InformationBarrierRecipientStatus

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies.

Note: This cmdlet doesn't work with information barriers in non-legacy mode. To determine your current mode, see Check the IB mode for your organization. If you're in non-legacy mode, run the following command to get information about a single recipient: Get-Recipient -Identity <IdentityValue> | Format-List Name,*segment*. Similarly, to get the relationship information between two recipients, use the Get-ExoInformationBarrierRelationship cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-JournalRule cmdlet to view the journal rules in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Label

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-Label cmdlet to view sensitivity labels in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-LabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-LabelPolicy cmdlet to view sensitivity label policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MessageClassification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MessageClassification cmdlet to view existing message classifications in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OrganizationSegment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-OrganizationSegment cmdlet to view organization segments in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-OutlookProtectionRule cmdlet to retrieve Microsoft Outlook protection rules configured in an organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ProtectionAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ProtectionAlert cmdlet to view alert policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ReviewItems

This cmdlet is available only in the cloud-based service.

Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label.

This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewPolicyV2

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-TransportRuleAction

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-TransportRuleAction cmdlet to view the actions that are available for transport rules (mail flow rules).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-TransportRulePredicate

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-JournalRuleCollection

This cmdlet is available only in on-premises Exchange.

Use the Import-JournalRuleCollection cmdlet to import journal rules from an XML file. You can import a journal rule collection you previously exported as a backup, or import rules you exported from an older version of Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-TransportRuleCollection

This cmdlet is available only in on-premises Exchange.

Use the Import-TransportRuleCollection cmdlet to import a transport rule collection. You can import a rule collection you previously exported as a backup, or import rules that you've exported from an older version of Exchange.

Note: For replacement import functionality in Exchange Online using a PowerShell script, see Import or export a mail flow rule collection in Exchange Online.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Install-UnifiedCompliancePrerequisite

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint Online. The Compliance Policy Center is a site collection that's used by the Microsoft Purview compliance portal to store preservation policies that act on content in SharePoint Online sites.

Typically, you don't need to run this cmdlet. You use this cmdlet for troubleshooting and diagnostics.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Invoke-ComplianceSecurityFilterAction

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Invoke-ComplianceSecurityFilterAction cmdlet to view and set compliance boundaries for Microsoft OneDrive sites in cloud-based organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ActivityAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note: Activity alerts have been effectively replaced by alert policies and the corresponding *-ProtectionAlert cmdlets. For more information about alert policies, see Alert policies in Microsoft 365.

Use the New-ActivityAlert cmdlet to create activity alerts. Activity alerts send email notifications when users perform specific activities in Microsoft 365.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AutoSensitivityLabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policies in your organization. Create auto-labeling policy rules using the New-AutoSensitivityLabelRule cmdlet and associate them with the policy to complete the policy creation.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AutoSensitivityLabelRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AutoSensitivityLabelRule cmdlet to create auto-labeling rules and associate then with auto-labeling policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-InformationBarrierPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-InformationBarrierPolicy cmdlet to create information barrier policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-JournalRule cmdlet to create a journal rule in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-Label

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-Label cmdlet to create sensitivity labels in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-LabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-LabelPolicy cmdlet to create sensitivity label policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MessageClassification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MessageClassification cmdlet to create a message classification instance in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-OrganizationSegment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-OrganizationSegment cmdlet to create organization segments for use with information barrier policies in the Microsoft Purview compliance portal. Organization Segments are not in effect until you apply information barrier policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-OutlookProtectionRule cmdlet to create a Microsoft Outlook protection rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ProtectionAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ProtectionAlert cmdlet to create alert policies in the Microsoft Purview compliance portal. Alert policies contain conditions that define the user activities to monitor, and the notification options for email alerts and entries in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SupervisoryReviewPolicyV2

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SupervisoryReviewRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-SupervisoryReviewRule cmdlet to create supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization.

Note:

  • The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization.

  • Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ActivityAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note: Activity alerts have been effectively replaced by alert policies and the corresponding *-ProtectionAlert cmdlets. For more information about alert policies, see Alert policies in Microsoft 365.

Use the Remove-ActivityAlert cmdlet to remove activity alerts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AutoSensitivityLabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policies from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AutoSensitivityLabelRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policy rules from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-InformationBarrierPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-InformationBarrierPolicy cmdlet to remove information barrier policies from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-JournalRule cmdlet to remove an existing journal rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-Label

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-Label cmdlet to remove sensitivity labels from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-LabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-LabelPolicies cmdlet to remove sensitivity label policies from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MessageClassification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MessageClassification cmdlet to delete an existing message classification instance from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-OrganizationSegment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-OrganizationSegment cmdlet to remove organization segments from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-OutlookProtectionRule cmdlet to remove Outlook protection rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ProtectionAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ProtectionAlert cmdlet to remove alert policies from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RecordLabel

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-RecordLabel cmdlet to remove record labels from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SupervisoryReviewPolicyV2

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-TransportRule cmdlet to remove transport rules (mail flow rules) from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ActivityAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note: Activity alerts have been effectively replaced by alert policies and the corresponding *-ProtectionAlert cmdlets. For more information about alert policies, see Alert policies in Microsoft 365.

Use the Set-ActivityAlert cmdlet to modify activity alerts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AutoSensitivityLabelPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AutoSensitivityLabelRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policy rules in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-InformationBarrierPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-InformationBarrierPolicy cmdlet to modify information barrier policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-JournalRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-JournalRule cmdlet to modify an existing journal rule in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Label

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-Label cmdlet to modify sensitivity labels in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-LabelPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-Label cmdlet to modify sensitivity label policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MessageClassification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-OrganizationSegment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-OrganizationSegment cmdlet to modify organization segments in the Microsoft Purview compliance portal. Organization Segments are not in effect until you apply information barrier policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-OutlookProtectionRule

Note: This cmdlet is no longer supported in the cloud-based service.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-OutlookProtectionRule cmdlet to modify an existing Microsoft Outlook protection rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ProtectionAlert

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-ProtectionAlert cmdlet to modify alert policies in the Microsoft Purview compliance portal.

Note: You can't use this cmdlet to edit default alert policies. You can only modify alerts that you created using the New-ProtectionAlert cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SupervisoryReviewPolicyV2

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SupervisoryReviewRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-TransportRule

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization.

Note:

  • The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization.

  • Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-InformationBarrierPoliciesApplication

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Start-InformationBarrierPoliciesApplication cmdlet to apply active information barrier policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-InformationBarrierPoliciesApplication

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Stop-InformationBarrierPoliciesApplication cmdlet to stop the process of applying information barrier policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-ArchiveConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-ArchiveConnectivity cmdlet to verify archive functionality for a mailbox user.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

policy-and-compliance-audit

Get-AdminAuditLogConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AdminAuditLogConfig cmdlet to view the administrator audit logging configuration settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuditConfig

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AuditConfig cmdlet to view the auditing configuration in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuditConfigurationPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AuditConfigurationPolicy cmdlet to view audit configuration policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuditConfigurationRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AuditConfigurationRule cmdlet to view audit configuration rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AuditLogSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AuditLogSearch cmdlet to return a list of current audit log searches that were created with the New-AdminAuditLogSearch or New-MailboxAuditLogSearch cmdlets. The Get-AuditLogSearch cmdlet also returns audit log searches that are initiated whenever an administrator uses the Exchange admin center (EAC) to export audit logs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxAuditBypassAssociation

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the Set-MailboxAuditBypassAssociation cmdlet to enable this property to bypass mailbox audit logging.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UnifiedAuditLogRetentionPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-UnifiedAuditLogRetentionPolicy cmdlet to view the properties of the audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AdminAuditLogSearch

Note

This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: https://aka.ms/AdminAuditCmdletBlog.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-AdminAuditLogSearch cmdlet to search the contents of the administrator audit log and send the results to one or more mailboxes that you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AuditConfigurationPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AuditConfigurationPolicy cmdlet to create audit configuration policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AuditConfigurationRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AuditConfigurationRule cmdlet to create audit configuration rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxAuditLogSearch

Note

This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: https://aka.ms/AuditCmdletBlog.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailboxAuditLogSearch cmdlet to search mailbox audit logs and have search results sent via email to specified recipients.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UnifiedAuditLogRetentionPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-UnifiedAuditLogRetentionPolicy cmdlet to create audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AuditConfigurationPolicy

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AuditConfigurationPolicy cmdlet to remove audit configuration policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AuditConfigurationRule

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AuditConfigurationRule cmdlet to remove audit configuration rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UnifiedAuditLogRetentionPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-UnifiedAuditLogRetentionPolicy cmdlet to delete audit log retention policies from the Microsoft Defender portal or the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Search-AdminAuditLog

Note

This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: https://aka.ms/AdminAuditCmdletBlog.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log. Administrator audit logging records when a user or administrator makes a change in your organization (in the Exchange admin center or by using cmdlets).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Search-MailboxAuditLog

Note

This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: https://aka.ms/AuditCmdletBlog.

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Search-UnifiedAuditLog

This cmdlet is available only in the cloud-based service.

Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object.

Note: By default, this cmdlet returns a subset of results containing up to 100 records. Use SessionCommand parameter with the ReturnLargeSet value to exhaustively search up to 50,000 results. The SessionCommand parameter causes the cmdlet to return unsorted data.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AdminAuditLogConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-AdminAuditLogConfig cmdlet to configure the administrator audit logging configuration settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AuditConfig

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AuditConfig cmdlet to configure the auditing configuration in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AuditConfigurationRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AuditConfigurationRule cmdlet to modify audit configuration rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxAuditBypassAssociation

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxAuditBypassAssociation cmdlet to configure mailbox audit logging bypass for user or computer accounts such as service accounts for applications that access mailboxes frequently.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UnifiedAuditLogRetentionPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-UnifiedAuditLogRetentionPolicy cmdlet to modify audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Write-AdminAuditLog

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceSearchAction

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceSecurityFilter

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Invoke-ComplianceSearchActionStep

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

This cmdlet is reserved for internal Microsoft use.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. You use this cmdlet to define the search criteria.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceSearchAction

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceSecurityFilter

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailboxSearch cmdlet to create a mailbox search and either get an estimate of search results, place search results on In-Place Hold or copy them to a Discovery mailbox. You can also place all contents in a mailbox on hold by not specifying a search query, which accomplishes similar results as Litigation Hold.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Microsoft Purview compliance portal. The searches must be stopped or completed.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceSearchAction

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceSearch cmdlet to remove compliance search actions from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceSecurityFilter

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceSecurityFilter cmdlet to remove compliance security filters from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailboxSearch cmdlet to remove a mailbox search.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceSearchAction

This cmdlet is functional only in on-premises Exchange.

Use the Set-ComplianceSearchAction cmdlet to change the export key on export compliance search actions in on-premises Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceSecurityFilter

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxSearch cmdlet to modify an existing mailbox search.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-ComplianceSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-MailboxSearch

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress.

Note: As of October 2020, the *-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the *-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see Retirement of legacy eDiscovery tools.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

policy-and-compliance-dlp

Export-ActivityExplorerData

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Export-ActivityExplorerData cmdlet to export activities from Data classification > Activity Explorer in the Microsoft 365 Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-DlpPolicyCollection

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post.

This cmdlet is functional only in on-premises Exchange.

Use the Export-DlpPolicyCollection cmdlet to export data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) from your organization to a file.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ClassificationRuleCollection

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ClassificationRuleCollection cmdlet to view the classification rule collections in your organization.

In the Microsoft Purview compliance portal, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DataClassification

This cmdlet is functional only in on-premises Exchange.

In Exchange Online, this cmdlet has been replaced by the Get-DlpSensitiveInformationType cmdlet in Security & Compliance PowerShell.

Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DataClassificationConfig

This cmdlet is available only in the cloud-based service.

Use the Get-DataClassificationConfig cmdlet to view the data classification configuration for your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpCompliancePolicy to view data loss prevention (DLP) policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpComplianceRule to view data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules identify and protect sensitive information.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpDetailReport

Note: This cmdlet has been retired. Use the Export-ActivityExplorerData cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet.

This cmdlet is available only in the cloud-based service.

Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online, and OneDrive for Business in your cloud-based organization for the last 30 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpDetectionsReport

This cmdlet is available only in the cloud-based service.

Note: This cmdlet will be retired. Use the Export-ActivityExplorerData cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet.

Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization for the last 30 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpEdmSchema

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpEdmSchema cmdlet to view exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpIncidentDetailReport

This cmdlet is available only in the cloud-based service.

Note: This cmdlet will be retired. Use the Export-ActivityExplorerData instead.

Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpKeywordDictionary

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpKeywordDictionary cmdlet to view data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpPolicy

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post. Use the Get-DlpCompliancePolicy and Get-DlpComplianceRule cmdlets instead.

This cmdlet is functional only in on-premises Exchange.

Use the Get-DlpPolicy cmdlet to view existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpPolicyTemplate

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post.

This cmdlet is functional only in on-premises Exchange.

Use the Get-DlpPolicyTemplate cmdlet to view existing data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) in your Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpSensitiveInformationType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpSensitiveInformationType cmdlet to list the sensitive information types that are defined for your organization in the Microsoft Purview compliance portal. Sensitive information types are used by data loss prevention (DLP) rules to check for sensitive information such as social security, passport, or credit card numbers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpSensitiveInformationTypeRulePackage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DlpSensitiveInformationTypeRulePackage cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DlpSiDetectionsReport

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note: This cmdlet will be retired. Use the Export-ActivityExplorerData cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet.

Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PolicyConfig

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-PolicyConfig cmdlet to view the endpoint restrictions that are configured in the organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PolicyTipConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-DlpPolicyCollection

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post.

This cmdlet is functional only in on-premises Exchange.

Use the Import-DlpPolicyCollection cmdlet to import data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) into your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-DlpPolicyTemplate

This cmdlet is available only in on-premises Exchange.

Use the Import-DlpPolicyTemplate cmdlet to import data loss prevention (DLP) policy template files that are based on transport rules (mail flow rules) into your Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ClassificationRuleCollection

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ClassificationRuleCollection cmdlet to import new classification rule collections into your organization.

In tSecurity & Compliance PowerShell, use the New-DlpSensitiveInformationTypeRulePackage cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DataClassification

This cmdlet is functional only in on-premises Exchange.

In Exchange Online, this cmdlet has been replaced by the New-DlpSensitiveInformationType cmdlet in Security & Compliance PowerShell.

Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpCompliancePolicy cmdlet to create data loss prevention (DLP) policies in the Microsoft Purview compliance portal. DLP policies contain DLP rules that identify, monitor, and protect sensitive information.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpComplianceRule to create data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule matches.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpEdmSchema

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpEdmSchema cmdlet to create exact data match (EDM)-based classification schemas in the Microsoft Purview compliance portal. Such schemas can be used with data loss prevention (DLP) policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpFingerprint

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpFingerprint cmdlet to create document fingerprints that are used with data loss prevention (DLP) sensitive information types in the Microsoft Purview compliance portal. Because the results of New-DlpFingerprint aren't stored outside of the sensitive information type, you always run New-DlpFingerprint and New-DlpSensitiveInformationType or Set-DlpSensitiveInformationType in the same PowerShell session.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpKeywordDictionary

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpKeywordDictionary cmdlet to create data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpPolicy

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post. Use the New-DlpCompliancePolicy and New-DlpComplianceRule cmdlets instead.

This cmdlet is functional only in on-premises Exchange.

Use the New-DlpPolicy cmdlet to create data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpSensitiveInformationType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpSensitiveInformationType cmdlet to create sensitive information type rules that use document fingerprints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DlpSensitiveInformationTypeRulePackage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-DlpSensitiveInformationTypeConfig cmdlet to import data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-Fingerprint

This cmdlet is functional only in on-premises Exchange.

Note: In Exchange Online, this cmdlet has been replaced by the New-DlpFingerPrint cmdlet in Security & Compliance PowerShell.

Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-DataClassification in the same PowerShell session.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PolicyTipConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PolicyTipConfig cmdlet to create custom Policy Tips in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ClassificationRuleCollection

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ClassificationRuleCollection to remove classification rule collections from your organization.

In Security & Compliance PowerShell, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DataClassification

This cmdlet is functional only in on-premises Exchange.

In Exchange Online, this cmdlet has been replaced by the Remove-DlpSensitiveInformationType cmdlet in Security & Compliance PowerShell.

Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpCompliancePolicy cmdlet to remove data loss prevention (DLP) policies from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpComplianceRule cmdlet to remove Data Loss Prevention (DLP) rules from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpEdmSchema

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpEdmSchema cmdlet to remove exact data match (EDM) data loss prevention (DLP) schemas from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpKeywordDictionary

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpKeywordDictionary cmdlet to remove data loss prevention (DLP) keyword dictionaries from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpPolicy

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post. Use the Remove-DlpCompliancePolicy and Remove-DlpComplianceRule cmdlets instead.

This cmdlet is functional only in on-premises Exchange.

Use the Remove-DlpPolicy cmdlet to remove existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpPolicyTemplate

This cmdlet is available only in on-premises Exchange.

Use the Remove-DlpPolicyTemplate cmdlet to remove data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpSensitiveInformationType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpSensitiveInformationType cmdlet to remove sensitive information type rules that use document fingerprints. You can't use this cmdlet to remove built-in sensitive information type rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DlpSensitiveInformationTypeRulePackage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-DlpSensitiveInformationTypeConfig cmdlet to remove data loss prevention (DLP) sensitive information type rule packages from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PolicyTipConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PolicyTipConfig cmdlet to remove custom data loss prevention (DLP) Policy Tips from your organization. You can't remove built-in Policy Tips.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ClassificationRuleCollection

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ClassificationRuleCollection cmdlet to update existing classification rule collections in your organization.

In the Microsoft Purview compliance portal, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DataClassification

This cmdlet is functional only in on-premises Exchange.

In Exchange Online, this cmdlet has been replaced by the Set-DlpSensitiveInformationType cmdlet in Security & Compliance PowerShell.

Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DlpCompliancePolicy cmdlet to modify data loss prevention (DLP) policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DlpComplianceRule to modify data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule violations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpEdmSchema

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DlpEdmSchema cmdlet to modify exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpKeywordDictionary

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpPolicy

Note: This cmdlet has been retired from the cloud-based service. For more information, see this blog post. Use the Set-DlpCompliancePolicy and Set-DlpComplianceRule cmdlets instead.

This cmdlet is functional only in on-premises Exchange.

Use the Set-DlpPolicy cmdlet to modify data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpSensitiveInformationType

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-DlpSensitiveInformationType cmdlet to modify sensitive information type rules that use document fingerprints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DlpSensitiveInformationTypeRulePackage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-DlpSensitiveInformationTypeRulePackage cmdlet to update existing data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PolicyConfig

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-PolicyConfig cmdlet to modify the endpoint restrictions that are configured in the organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PolicyTipConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PolicyTipConfig cmdlet to modify custom Policy Tips in your organization. You can't modify built-in Policy Tips.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-DataClassification

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-TextExtraction

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-TextExtraction cmdlet to find the text that is extracted from a specified email message in Exchange flow.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

policy-and-compliance-ediscovery

Add-ComplianceCaseMember

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Add-ComplianceCaseMember cmdlet to add an individual member to an eDiscovery case in the Microsoft Purview compliance portal. To replace all existing members, use the Update-ComplianceCaseMember cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-eDiscoveryCaseAdmin

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Add-eDiscoveryCaseAdmin cmdlet to add an eDiscovery Administrator in the Microsoft Purview compliance portal. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-CaseHoldPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-CaseHoldRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-CaseHoldRule to view case hold rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceCase

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Microsoft Purview compliance portal. See the CaseType parameter for a list of these case types.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceCaseMember

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceCaseMember cmdlet to view the members of eDiscovery cases in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-eDiscoveryCaseAdmin

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-eDiscoveryCaseAdmin cmdlet to view eDiscovery Administrators in the Microsoft Purview compliance portal. An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-CaseHoldPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-CaseHoldPolicy cmdlet to create new case hold policies in the Microsoft Purview compliance portal.

Note

After you use the New-CaseHoldPolicy cmdlet to create a case hold policy, you need to use the New-CaseHoldRule cmdlet to create a case hold rule and assign the rule to the policy. If you don't create a rule for the policy, the hold won't be created, and content locations won't be placed on hold.

Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to create multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see Get-CaseHoldPolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-CaseHoldRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-CaseHoldRule cmdlet to create new case hold rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceCase

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ComplianceCase cmdlet to create eDiscovery cases in the Microsoft Purview compliance portal. You use eDiscovery cases to place content locations on hold, perform Content Searches associated with the case, and export search results.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-CaseHoldPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-CaseHoldPolicy cmdlet to remove case hold policies from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-CaseHoldRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-CaseHoldRule cmdlet to remove case hold rules from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceCase

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceCase cmdlet to remove compliance cases from the Microsoft Purview compliance portal or the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceCaseMember

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceCaseMember cmdlet to remove a single member from an eDiscovery search in Security & Compliance. To replace all existing members, use the Update-ComplianceCaseMember cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-eDiscoveryCaseAdmin

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-eDiscoveryCaseAdmin cmdlet to remove an eDiscovery Administrator from the Microsoft Purview compliance portal. To replace all eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CaseHoldPolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal.

Note: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see Get-CaseHoldPolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CaseHoldRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-CaseHoldRule cmdlet to modify existing case hold rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceCase

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-ComplianceCase cmdlet to modify eDiscovery cases in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-ComplianceCaseMember

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Update-ComplianceCaseMember cmdlet to replace all members of eDiscovery cases in the Microsoft Purview compliance portal. To add or remove existing members, use the Add-ComplianceCaseMember and Remove-ComplianceCaseMember cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-eDiscoveryCaseAdmin

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Update-eDiscoveryCaseAdmin cmdlet to replace all existing eDiscovery Administrators in the Microsoft Purview compliance portal. To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

policy-and-compliance-retention

Enable-ComplianceTagStorage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Enable-ComplianceTagStorage cmdlet to create the retention label policy in the Microsoft Purview compliance portal. This is a one-time operation. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-ContentExplorerData

Note: This cmdlet is currently in Preview and is subject to change.

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Export-ContentExplorerData cmdlet to export data classification file details in Microsoft Purview compliance.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-FilePlanProperty

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Export-FilePlanProperty cmdlet to export file plan properties.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AdaptiveScope

This cmdlet is available only in the cloud-based service.

Use the Get-AdaptiveScope cmdlet to view adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AppRetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AppRetentionCompliancePolicy to view app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AppRetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-AppRetentionComplianceRule to view app retention compliance rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceRetentionEvent

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceRetentionEventType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceTag

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceTag cmdlet to view retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ComplianceTagStorage

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceTagStorage cmdlet to confirm that you've created the retention label policy by using the Enable-ComplianceTagStorage cmdlet. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DataRetentionReport

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-DataRetentionReport cmdlet to view information about data retention in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyAuthority

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertyAuthority cmdlet to view file plan property authorities.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Fet-FilePlanPropertyCategory cmdlet to view file plan property categories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyCitation

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertyCitation cmdlet to view file plan property citations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyDepartment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertyDepartment cmdlet to view file plan property departments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyReferenceId

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertyReferenceId cmdlet to view file plan property reference IDs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertyStructure

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertyStructure cmdlet to the view file plan property structure in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-FilePlanPropertySubCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-FilePlanPropertySubCategory cmdlet to view file plan property subcategories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-HoldCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-HoldCompliancePolicy to view existing preservation policies in the Microsoft Purview compliance portal.

Note: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-HoldComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-HoldComplianceRule to view preservation rules in the Microsoft Purview compliance portal.

Note: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagedContentSettings

This cmdlet is available only in Exchange Server 2010.

Use the Get-ManagedContentSettings cmdlet to retrieve managed content settings associated with managed folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagedFolder

This cmdlet is available only in Exchange Server 2010.

Use the Get-ManagedFolder cmdlet to retrieve the attributes of one or more managed folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagedFolderMailboxPolicy

This cmdlet is available only in Exchange Server 2010.

Use the Get-ManagedFolderMailboxPolicy cmdlet to return all attributes of one or more managed folder mailbox policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RecordReviewNotificationTemplateConfig

This cmdlet is available only in the cloud-based service.

Use the Get-RecordReviewNotificationTemplateConfig cmdlet to view the record review notification and reminder settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RegulatoryComplianceUI

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell .

Use the Get-RegulatoryComplianceUI cmdlet to view the status of the regulatory compliance UI in the Microsoft Purview compliance portal (whether the preservation lock checkbox is displayed for retention policies and the immutable label checkbox is displayed for retention labels).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-RetentionCompliancePolicy to view existing retention policies in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-RetentionComplianceRule to view retention rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RetentionEvent

This cmdlet is available only in the cloud-based service.

Use the Get-RetentionEvent cmdlet to view retention events in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RetentionPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RetentionPolicyTag

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-FilePlanProperty

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Import-FilePlanProperty cmdlet to import file plan properties.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Invoke-HoldRemovalAction

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Invoke-HoldRemovalAction cmdlet to view and remove holds on mailboxes and SharePoint sites. You can also see holds that were previously removed by using this cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AdaptiveScope

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AdaptiveScope cmdlet to create adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AppRetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AppRetentionCompliancePolicy to create app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AppRetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-AppRetentionComplianceRule to create app retention compliance rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceRetentionEvent

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ComplianceRetentionEvent cmdlet to create compliance retention events in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceRetentionEventType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ComplianceRetentionEventType cmdlet to create retention event types in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ComplianceTag

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-ComplianceTag cmdlet to create retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertyAuthority

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyAuthority cmdlet to create file plan property authorities.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertyCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyCategory cmdlet to create file plan property categories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertyCitation

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyCitation cmdlet to create file plan property citations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertyDepartment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyDepartment cmdlet to create file plan property departments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertyReferenceId

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyReferenceId cmdlet to create file plan property reference IDs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-FilePlanPropertySubCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertySubCategory cmdlet to create file plan property subcategories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-HoldCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Microsoft Purview compliance portal.

Note: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-HoldComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Microsoft Purview compliance portal.

Note: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagedContentSettings

This cmdlet is available only in Exchange Server 2010.

Use the New-ManagedContentSettings cmdlet to create managed content settings for managed folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagedFolder

This cmdlet is available only in Exchange Server 2010.

Use the New-ManagedFolder cmdlet to create a managed folder object for messaging records management (MRM).

This command doesn't accept pipelined input.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagedFolderMailboxPolicy

This cmdlet is available only in Exchange Server 2010.

Use the New-ManagedFolderMailboxPolicy cmdlet to create a managed folder mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-RetentionCompliancePolicy cmdlet to create new retention policies and new retention label policies in the Microsoft Purview compliance portal. Creating a new policy also requires use of the New-RetentionComplianceRule cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-RetentionComplianceRule cmdlet to create new retention rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RetentionPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-RetentionPolicy cmdlet to create a retention policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RetentionPolicyTag

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-RetentionPolicyTag cmdlet to create a retention tag.

For more information about retention tags, see Retention tags and retention policies in Exchange Server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AdaptiveScope

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AdaptiveScope cmdlet to remove adaptive scopes from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AppRetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AppRetentionCompliancePolicy to remove app retention compliance policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AppRetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-AppRetentionComplianceRule to remove app retention compliance rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceRetentionEventType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceRetentionEventType cmdlet to remove retention event types in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ComplianceTag

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-ComplianceTag cmdlet to remove retention labels from the Microsoft Purview compliance portal. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertyAuthority

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-FilePlanPropertyAuthority cmdlet to remove file plan property authorities.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertyCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-FilePlanPropertyCategory cmdlet to remove file plan property categories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertyCitation

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-FilePlanPropertyCitation cmdlet to remove file plan property citations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertyDepartment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Removet-FilePlanPropertyDepartment cmdlet to remove file plan property departments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertyReferenceId

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the New-FilePlanPropertyReferenceId cmdlet to remove file plan property reference IDs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-FilePlanPropertySubCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-FilePlanPropertySubCategory cmdlet to remove file plan property subcategories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-HoldCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-HoldCompliancePolicy cmdlet to remove preservation policies from the Microsoft Purview compliance portal.

Note: The Remove-HoldCompliancePolicy cmdlet has been replaced by the Remove-RetentionCompliancePolicy cmdlet. If you have scripts that use Remove-HoldCompliancePolicy, update them to use Remove-RetentionCompliancePolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-HoldComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Microsoft Purview compliance portal.

Note: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagedContentSettings

This cmdlet is available only in Exchange Server 2010.

Use the Remove-ManagedContentSettings cmdlet to delete managed content settings from a managed folder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagedFolder

This cmdlet is available only in Exchange Server 2010.

Use the Remove-ManagedFolder cmdlet to remove a managed folder from Active Directory.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagedFolderMailboxPolicy

This cmdlet is available only in Exchange Server 2010.

Use the Remove-ManagedFolderMailboxPolicy cmdlet to delete managed folder mailbox policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-RetentionCompliancePolicy cmdlet to remove retention policies from the Microsoft Purview compliance portal. This cmdlet also removes the corresponding retention rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Remove-RetentionComplianceRule cmdlet to remove retention rules from the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RetentionPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-RetentionPolicy cmdlet to remove a retention policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RetentionPolicyTag

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-RetentionPolicyTag cmdlet to remove a retention tag.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AdaptiveScope

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AdaptiveScope cmdlet to modify adaptive scopes in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AppRetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AppRetentionCompliancePolicy to modify app retention compliance policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AppRetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-AppRetentionComplianceRule to modify app retention compliance rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceRetentionEventType

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-ComplianceRetentionEventType cmdlet to modify retention event types in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ComplianceTag

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-ComplianceTag cmdlet to modify retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertyAuthority

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyAuthority cmdlet to modify file plan property authorities.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertyCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyCategory cmdlet to modify file plan property categories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertyCitation

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyCitation cmdlet to modify file plan property citations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertyDepartment

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyDepartment cmdlet to modify file plan property departments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertyReferenceId

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyReferenceId cmdlet to modify file plan property reference IDs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-FilePlanPropertySubCategory

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertySubCategory cmdlet to modify file plan property subcategories.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-HoldCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Microsoft Purview compliance portal.

Note: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-HoldComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Microsoft Purview compliance portal.

Note: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagedContentSettings

This cmdlet is available only in Exchange Server 2010.

Use the Set-ManagedContentSettings cmdlet to modify existing managed content settings for a managed folder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagedFolder

This cmdlet is available only in Exchange Server 2010.

Use the Set-ManagedFolder cmdlet to modify the settings of managed folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagedFolderMailboxPolicy

This cmdlet is available only in Exchange Server 2010.

Use the Set-ManagedFolderMailboxPolicy cmdlet to change the settings of a managed folder mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RecordReviewNotificationTemplateConfig

This cmdlet is available only in the cloud-based service.

Use the Set-RecordReviewNotificationTemplateConfig cmdlet to set up the customized record review notification and reminder that's sent when an item requires review.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RegulatoryComplianceUI

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell .

Use the Set-RegulatoryComplianceUI cmdlet to display the UI option in retention label settings to mark content as a regulatory record.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RetentionCompliancePolicy

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Microsoft Purview compliance portal.

Note: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see Get-RetentionCompliancePolicy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RetentionComplianceRule

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-RetentionComplianceRule cmdlet to modify existing retention rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RetentionPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RetentionPolicyTag

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-RetentionPolicyTag cmdlet to modify the properties of a retention tag.

For more information about retention tags, see Retention tags and retention policies in Exchange Server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-ManagedFolderAssistant

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Start-RetentionAutoTagLearning

This cmdlet is available only in Exchange Server 2010.

Use the Start-RetentionAutoTagLearning cmdlet to start auto-tagging for a specified mailbox or to cross-validate auto-tagging results for the mailbox.

Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see Understanding Retention Tags and Retention Policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Stop-ManagedFolderAssistant

This cmdlet is available only in on-premises Exchange.

Use the Stop-ManagedFolderAssistant cmdlet to immediately stop messaging records management (MRM) from processing users' mailboxes on the specified servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Validate-RetentionRuleQuery

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Validate-RetentionRuleQuery cmdlet to validate the Keyword Query Language (KQL) content search filters for retention rules.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

powershell-v3-module

Add-VivaModuleFeaturePolicy

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Note: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.

Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature or a category in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant.

  • You can assign up to 10 policies per feature/category. An additional one policy per feature/category can be assigned to the entire tenant.
  • Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies.
  • If a category is disabled by category policies, all features under the category are disabled regardless of the policies set at the feature level.
  • You can only update user controls at the feature policy level, not the category policy level.
  • Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the Get-VivaModuleFeature cmdlet.

Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-VivaOrgInsightsDelegatedRole

This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see About the Exchange Online PowerShell module.

Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegate) so they can view organizational insights like the leader (the delegator).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Connect-ExchangeOnline

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for accounts with or without multi-factor authentication (MFA).

To connect to Security & Compliance PowerShell, use the Connect-IPPSSession cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Connect-IPPSSession

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts.

Note: Version 3.2.0 or later of the module supports REST API mode for virtually all Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see Prerequisites for the Exchange Online PowerShell module.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disconnect-ExchangeOnline

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Disconnect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to disconnect the connections that you created using the Connect-ExchangeOnline or Connect-IPPSSession cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ConnectionInformation

This cmdlet is available in the Exchange Online PowerShell module v3.0.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-ConnectionInformation cmdlet to get information about all REST-based connections in the current PowerShell instance with Exchange Online.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DefaultTenantBriefingConfig

This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see Configure Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DefaultTenantMyAnalyticsFeatureConfig

This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-DefaultTenantMyAnalyticsFeatureConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOCasMailbox

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOCasMailbox cmdlet to view the Client Access settings that are configured on mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMailbox

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMailboxFolderPermission

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMailboxFolderStatistics

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOMailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMailboxPermission

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOMailboxPermission cmdlet to retrieve permissions on a mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMailboxStatistics

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOMailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXOMobileDeviceStatistics

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXOMobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXORecipient

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EXORecipientPermission

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MyAnalyticsFeatureConfig

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user.

Note: This cmdlet replaces the Get-UserAnalyticsConfig cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UserBriefingConfig

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see Configure Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-VivaInsightsSettings

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Note: This cmdlet is available only in version 2.0.5 or later of the module.

Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-VivaModuleFeature

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. This cmdlet provides details about the features, including the feature identifiers and descriptions.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-VivaModuleFeatureEnablement

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-VivaModuleFeaturePolicy

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Note: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.

Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module or category in Viva. Policies are used to restrict or grant access to the specified feature or category for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-VivaOrgInsightsDelegatedRole

This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see About the Exchange Online PowerShell module.

Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-VivaModuleFeaturePolicy

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Note: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.

Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module or a category in Viva. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-VivaOrgInsightsDelegatedRole

This cmdlet is available only in the Exchange Online PowerShell module v3.7.0-Preview1 or later. For more information, see About the Exchange Online PowerShell module.

Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegate) so they can't view organizational insights like the leader (the delegator).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DefaultTenantBriefingConfig

This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see Configure Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DefaultTenantMyAnalyticsFeatureConfig

This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Use the Set-DefaultTenantMyAnalyticsFeatureConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MyAnalyticsFeatureConfig

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user.

Note: This cmdlet replaces the Set-UserAnalyticsConfig cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UserBriefingConfig

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing email for a user. For more details about configuring the Briefing email, see Configure Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-VivaInsightsSettings

This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.

Note: This cmdlet is available only in version 2.0.5 or later of the module.

Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-VivaModuleFeaturePolicy

This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see About the Exchange Online PowerShell module.

Note: Support for categories is available in version 3.5.0-Preview2 or later of the module, but no categories are currently available in Viva. We'll update the documentation when categories are available.

Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module or a category in Viva.

  • You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported.
  • Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature/category is enabled. If a user has multiple policies assigned for a feature/category (directly as a user or member of a group), the most restrictive policy applies.
  • You can only update user controls at the feature policy level, not the category policy level.
  • Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the Get-VivaModuleFeature cmdlet.

Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

reporting

Get-CompromisedUserAggregateReport

This cmdlet is available only in the cloud-based service.

Use the Get-CompromisedUserAggregateReport cmdlet to return general data about compromised users for the last 10 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-CompromisedUserDetailReport

This cmdlet is available only in the cloud-based service.

Use the Get-CompromisedUserDetailReport cmdlet to return detailed information about compromised users for the last 10 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-HistoricalSearch

This cmdlet is available only in the cloud-based service.

Use the Get-HistoricalSearch cmdlet to view information about historical searches that have been performed within the last ten days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-LogonStatistics

This cmdlet is functional only in Exchange Server 2010.

The Get-LogonStatistics cmdlet has been deprecated and is no longer used.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailDetailDlpPolicyReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailDetailDlpPolicyReport cmdlet to view the details of messages that matched the conditions defined by any data loss prevention (DLP) policies. This cmdlet works on messages that were sent within the last seven days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailDetailEncryptionReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailDetailEncryptionReport cmdlet to view the details of encryption in your cloud-based organization for the last 10 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailDetailTransportRuleReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailDetailTransportRuleReport cmdlet to view the details of messages that matched the conditions defined by any transport rules for the last 10 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailFilterListReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailFilterListReport cmdlet to obtain values for various parameters that can be supplied to other reporting cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailTrafficEncryptionReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailTrafficEncryptionReport cmdlet to view the results of encryption in your cloud-based organization for the last 92 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailTrafficPolicyReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailTrafficPolicyReport cmdlet to view statistics about messages that were affected by data loss prevention (DLP) policies and transport rules for the last 90 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailTrafficSummaryReport

This cmdlet is available only in the cloud-based service.

Use the Get-MailTrafficSummaryReport cmdlet to view summary information about message traffic in your organization for the last 90 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MxRecordReport

This cmdlet is available only in the cloud-based service.

Use the Get-MxRecordReport cmdlet to view information about the mail exchanger (MX) records that are configured for a specified domain.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OutboundConnectorReport

This cmdlet is available only in the cloud-based service.

Use the Get-OutboundConnectorReport cmdlet to view the Outbound connectors that are used to deliver mail to specific domains.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RecipientStatisticsReport

This cmdlet is available only in the cloud-based service.

Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ReportExecutionInstance

This cmdlet is available only in the cloud-based service.

Use the Get-ReportExecutionInstance cmdlet to review the report execution instance in Exchange Online.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SCInsights

This cmdlet is available only in the cloud-based service.

Use the Get-SCInsights cmdlet to view Microsoft 365 insights information.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ServiceDeliveryReport

This cmdlet is available only in the cloud-based service.

Use the Get-ServiceDeliveryReport cmdlet to view information about the message delivery path for a specified recipient.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewActivity

This cmdlet is available only in the cloud-based service.

Use the Get-SupervisoryReviewActivity cmdlet to view all activities performed by a reviewer for a specific supervision policy. This information may be useful if reviewer activities are required in regulatory compliance audits or in litigation.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewOverallProgressReport

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewOverallProgressReport cmdlet to view the total number of supervised communications classified as Pending, Resolved, Compliant, Non-compliant, and Questionable.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewPolicyReport

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewReport

This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewReport cmdlet to view supervisory review events in the Microsoft Purview compliance portal for the last 90 days.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SupervisoryReviewTopCasesReport

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-SupervisoryReviewTopCasesReport cmdlet to view the current status of the top supervision policies configured in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-Message

This cmdlet is functional only in the cloud-based service.

Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications will also be sent to any configured recipients.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

role-based-access-control

Add-ManagementRoleEntry

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-ManagementRoleEntry cmdlet to add management role entries to an existing management role.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-RoleGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-RoleGroupMember cmdlet to add members to a management role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagementRole

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ManagementRole cmdlet to view management roles that have been created in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagementRoleAssignment

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ManagementRoleAssignment cmdlet to retrieve management role assignments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagementRoleEntry

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ManagementRoleEntry cmdlet to retrieve management role entries that have been configured on management roles.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ManagementScope

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-ManagementScope cmdlet to return a list of management scopes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RoleAssignmentPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RoleAssignmentPolicy cmdlet to view existing management role assignment policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RoleGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RoleGroup cmdlet to retrieve a list of management role groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-RoleGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RoleGroupMember cmdlet to retrieve a list of members of a management role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagementRole

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ManagementRole cmdlet to create a management role based on an existing role or create an unscoped management role.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagementRoleAssignment

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ManagementRoleAssignment cmdlet to assign a management role to a management role group, management role assignment policy, user, or universal security group (USG).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ManagementScope

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-ManagementScope cmdlet to create a regular or exclusive management scope.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RoleAssignmentPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-RoleAssignmentPolicy cmdlet to create management role assignment policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RoleGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-RoleGroup cmdlet to create management role groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagementRole

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ManagementRole cmdlet to remove custom management roles that you don't need anymore.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagementRoleAssignment

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagementRoleEntry

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ManagementScope

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ManagementScope cmdlet to remove an existing management scope.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RoleAssignmentPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-RoleAssignmentPolicy cmdlet to remove existing management role assignment policies from your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RoleGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-RoleGroup cmdlet to remove a management role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-RoleGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-RoleGroupMember cmdlet to remove a member of a management role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagementRoleAssignment

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ManagementRoleAssignment cmdlet to modify existing management role assignments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagementRoleEntry

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ManagementRoleEntry cmdlet to change the available parameters on an existing management role entry.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ManagementScope

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-ManagementScope cmdlet to change an existing management scope.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RoleAssignmentPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-RoleAssignmentPolicy cmdlet to modify existing management role assignment policies in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-RoleGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-RoleGroup cmdlet to modify who can add or remove members to or from management role groups or change the name of the role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-RoleGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Update-RoleGroupMember cmdlet to modify the members of a management role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

server-health-and-performance

Add-GlobalMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Add-GlobalMonitoringOverride cmdlet to override the thresholds and parameters of the managed availability probes, monitors and responders on all Exchange 2013 or later servers in your organization. The cmdlet enables monitoring changes and threshold tuning to the environment.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-ServerMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Add-ServerMonitoringOverride cmdlet to override the thresholds and parameters of managed availability probes, monitors, and responders on Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AvailabilityReportOutage

This cmdlet is available only in Exchange Server 2010.

Use the Get-AvailabilityReportOutage cmdlet to return the daily downtime (if any) for each service entity and its overridden value (if set) to the overall reported availability for the day.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EventLogLevel

This cmdlet is available only in on-premises Exchange.

Use the Get-EventLogLevel cmdlet to display a list of Exchange event categories and the corresponding log levels on Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-GlobalMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Get-GlobalMonitoringOverride cmdlet to view the overrides of the thresholds and parameters of the managed availability probes, monitors and responders that are configured for all Exchange 2013 or later servers in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-HealthReport

This cmdlet is available only in on-premises Exchange.

Use the Get-HealthReport cmdlet to return health information for the Exchange server that you specify. You can use the health values to determine the state of the server. The cmdlet also returns an alert value that provides the specific state of your server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MonitoringItemHelp

This cmdlet is available only in on-premises Exchange.

Use the Get-MonitoringItemHelp cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. Monitoring items are preconfigured to help you with your server health and monitoring.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MonitoringItemIdentity

This cmdlet is available only in on-premises Exchange.

Use the Get-MonitoringItemIdentity cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ServerComponentState

This cmdlet is available only in on-premises Exchange.

Use the Get-ServerComponentState cmdlet to retrieve configuration settings for Microsoft Exchange components and endpoints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ServerHealth

This cmdlet is available only in on-premises Exchange.

Use the Get-ServerHealth cmdlet to return health information related to the server you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ServerMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Get-ServerMonitoringOverride cmdlet to return all overrides created on the specified server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ThrottlingPolicy

This cmdlet is available only in on-premises Exchange.

Use the Get-ThrottlingPolicy cmdlet to view the user throttling settings for one or more throttling policies.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ThrottlingPolicyAssociation

This cmdlet is available only in on-premises Exchange.

Use the Get-ThrottlingPolicyAssociation cmdlet to view existing throttling policy associations in your organization. Throttling policies can be associated with mailboxes, user accounts, mail contacts, mail users, and Exchange server computer accounts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Invoke-MonitoringProbe

This cmdlet is available only in on-premises Exchange.

Use the Invoke-MonitoringProbe cmdlet to run a Managed Availability probe on a selected server.

This cmdlet cannot be used to run every Managed Availability probe. Only some probes (mainly the deep test probes) can be run manually using this cmdlet. Probes that cannot be run with this cmdlet will generate an error message when Invoke-MonitoringProbe is used to run them.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AvailabilityReportOutage

This cmdlet is available only in Exchange Server 2010.

Use the New-AvailabilityReportOutage cmdlet to create an outage to add unrecorded issues to availability reporting.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-ThrottlingPolicy

This cmdlet is available only in on-premises Exchange.

Use the New-ThrottlingPolicy cmdlet to create a non-default user throttling policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AvailabilityReportOutage

This cmdlet is available only in Exchange Server 2010.

Use the Remove-AvailabilityReportOutage cmdlet to remove existing outages that have been added with the New-AvailabilityReportOutage cmdlet. Other outages must be modified with the Set-AvailabilityReportOutage cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-GlobalMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Remove-GlobalMonitoringOverride cmdlet to remove a managed availability global override that has been configured for a probe, monitor or responder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ServerMonitoringOverride

This cmdlet is available only in on-premises Exchange.

Use the Remove-ServerMonitoringOverride cmdlet to remove a managed availability local server override that has been configured for a probe, monitor or responder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-ThrottlingPolicy

This cmdlet is available only in on-premises Exchange.

Use the Remove-ThrottlingPolicy cmdlet to remove a non-default Microsoft Exchange throttling policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AvailabilityReportOutage

This cmdlet is available only in Exchange Server 2010.

Use the Set-AvailabilityReportOutage cmdlet to set the outages that contribute to the overall reported availability for the day.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-EventLogLevel

This cmdlet is available only in on-premises Exchange.

Use the Set-EventLogLevel cmdlet to set the event log level registry value for the specified category.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ServerComponentState

This cmdlet is available only in on-premises Exchange.

Use the Set-ServerComponentState cmdlet to configure and update Microsoft Exchange components and endpoints on servers you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ServerMonitor

This cmdlet is available only in on-premises Exchange.

Use the Set-ServerMonitor cmdlet to edit or set a parameter on a single monitor on an Exchange server.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ThrottlingPolicy

This cmdlet is available only in on-premises Exchange.

Use the Set-ThrottlingPolicy cmdlet to modify the settings for a user throttling policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ThrottlingPolicyAssociation

This cmdlet is available only in on-premises Exchange.

Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account.

Note: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. And, if you want to apply throttling policy to a remote mailbox, first populate the remote mailbox with an ExchangeGUID by using Set-RemoteMailbox -ExchangeGUID.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-ServiceHealth

This cmdlet is available only in on-premises Exchange.

Use the Test-ServiceHealth cmdlet to test whether all the Microsoft Windows services that Exchange requires on a server have started. The Test-ServiceHealth cmdlet returns an error for any service required by a configured role when the service is set to start automatically and isn't currently running.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

sharing-and-collaboration

Add-AvailabilityAddressSpace

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-AvailabilityAddressSpace cmdlet to create availability address space objects that are used to share free/busy data across Exchange organizations.

The maximum number off Availability address spaces returned by Active Directory to Exchange is 100. We recommend using 100 or fewer address spaces in order for Availability lookups to work properly.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-PublicFolderAdministrativePermission

This cmdlet is available only in Exchange Server 2010.

Use the Add-PublicFolderAdministrativePermission cmdlet to add administrative permissions to a public folder or a public folder hierarchy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-PublicFolderClientPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-MailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Disable-MailPublicFolder cmdlet to mail-disable a public folder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-MailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Enable-MailPublicFolder cmdlet to mail-enable public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AvailabilityAddressSpace

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AvailabilityAddressSpace cmdlet to view existing availability address space objects that are used to share free/busy data across Exchange organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-AvailabilityConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-AvailabilityConfig cmdlet to view information about the sharing of free/busy information between organizations:

  • In on-premises Exchange, the cmdlet returns the accounts that are trusted in the cross-forest sharing of free/busy information.
  • In Exchange Online, the cmdlet returns the tenant IDs of organizations that free/busy information is being shared with.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail-related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OrganizationRelationship

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that has been created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderAdministrativePermission

This cmdlet is available only in Exchange Server 2010.

Use the Get-PublicFolderAdministrativePermission cmdlet to get the administrative permissions for a public folder or a public folder hierarchy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderClientPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderDatabase

This cmdlet is available only in on-premises Exchange.

Use the Get-PublicFolderDatabase cmdlet to view public folder database settings for Microsoft Exchange Server 2010 or earlier public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderItemStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderItemStatistics cmdlet to view information about items within a specified public folder. Information returned includes subject, last modification time, creation time, attachments, message size, and the type of item. You can use this raw information to better understand the distribution of items and item characteristics across public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderMailboxDiagnostics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMailboxDiagnostics cmdlet to view event-level information about a public folder mailbox. This information can be used to troubleshoot public folder issues.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-PublicFolderStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderStatistics cmdlet to retrieve statistical information about public folders, such as folder size and last logon time.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SharingPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-SharingPolicy cmdlet to view existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SiteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SiteMailboxDiagnostics

This cmdlet is available only in on-premises Exchange.

Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SiteMailboxProvisioningPolicy

This cmdlet is available only in on-premises Exchange.

Use the Get-SiteMailboxProvisioningPolicy cmdlet to view site mailbox provisioning policies.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-AvailabilityConfig

This cmdlet is available only in the cloud-based service.

Use the New-AvailabilityConfig cmdlet to create the availability configuration that specifies the Microsoft 365 organizations to exchange free/busy information with.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-OrganizationRelationship

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-OrganizationRelationship cmdlet to create organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-PublicFolder cmdlet to create a public folder with the specified name.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PublicFolderDatabase

This cmdlet is available only in Exchange Server 2010.

Use the New-PublicFolderDatabase cmdlet to create a public folder database.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-PublicFolderDatabaseRepairRequest

This cmdlet is available only in Exchange Server 2010.

Use the New-PublicFolderDatabaseRepairRequest cmdlet to detect and fix replication issues in the public folder database.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SharingPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox.

Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing polices allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SiteMailboxProvisioningPolicy

This cmdlet is available only in on-premises Exchange.

Use the New-SiteMailboxProvisioningPolicy cmdlet to create provisioning policies for site mailboxes.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-SyncMailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

The New-SyncMailPublicFolder cmdlet is used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts to create mail-enabled public folder recipient objects in Exchange Online (the scripts synchronize mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AvailabilityAddressSpace

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-AvailabilityAddressSpace cmdlet to remove existing availability address space objects and the associated credentials that were used to share free/busy data across Exchange organizations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-AvailabilityConfig

This cmdlet is available only in the cloud-based service.

Use the Remove-AvailabilityConfig cmdlet to remove the availability configuration that specifies the Microsoft 365 organizations to exchange free/busy information with.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-OrganizationRelationship

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-OrganizationRelationship cmdlet to remove the organization relationship with an external Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PublicFolder cmdlet to remove an existing public folder.

The Remove-PublicFolder cmdlet removes the public folder data from all servers in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderAdministrativePermission

This cmdlet is available only in Exchange Server 2010.

Use the Remove-PublicFolderAdministrativePermission cmdlet to remove administrative permissions for a public folder or a public folder hierarchy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderClientPermission

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-PublicFolderClientPermission cmdlet to remove permissions from public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-PublicFolderDatabase

This cmdlet is available only in Exchange Server 2010.

Use the Remove-PublicFolderDatabase cmdlet to delete public folder databases.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SharingPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-SharingPolicy cmdlet to remove a sharing policy. Before you can remove a sharing policy, you must ensure that no mailbox users are provisioned to use that policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SiteMailboxProvisioningPolicy

This cmdlet is available only in on-premises Exchange.

Use the Remove-SiteMailboxProvisioningPolicy cmdlet to remove site mailbox provisioning policies.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-SyncMailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Exchange Online (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Resume-PublicFolderReplication

This cmdlet is available only in Exchange Server 2010.

Use the Resume-PublicFolderReplication cmdlet to resume public folder content replication when it's been stopped.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-AvailabilityConfig

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-AvailabilityConfig cmdlet to set the access level for free/busy information.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailPublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of mail-enabled public folders. If you want to configure basic settings that aren't mail-related, use the Set-PublicFolder cmdlet.

NOTE: The settings that you configure on a public folder mailbox might interfere with the existing settings on a public folder within in the mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-OrganizationRelationship

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PublicFolder

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PublicFolder cmdlet to set the attributes of public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PublicFolderDatabase

This cmdlet is available only in Exchange Server 2010.

Use the Set-PublicFolderDatabase cmdlet to set attributes of public folder databases.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SharingPolicy

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-SharingPolicy cmdlet to modify existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SiteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-SiteMailboxProvisioningPolicy

This cmdlet is available only in on-premises Exchange.

Use the Set-SiteMailboxProvisioningPolicy cmdlet to 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.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Suspend-PublicFolderReplication

This cmdlet is available only in Exchange Server 2010.

Use the Suspend-PublicFolderReplication cmdlet to stop public folder replication for the organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-OrganizationRelationship

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-OrganizationRelationship cmdlet to verify that the organization relationship is properly configured and functioning as expected.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-SiteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-PublicFolder

This cmdlet is available only in Exchange Server 2010.

Use the Update-PublicFolder cmdlet to start content synchronization of a public folder.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-PublicFolderHierarchy

This cmdlet is available only in Exchange Server 2010.

Use the Update-PublicFolderHierarchy cmdlet to start content synchronization of the public folder hierarchy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-PublicFolderMailbox

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Update-PublicFolderMailbox cmdlet to update the hierarchy for public folders.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-SiteMailbox

This cmdlet is available only in on-premises Exchange.

Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues.

Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

unified-messaging

Disable-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the Disable-UMAutoAttendant cmdlet to disable an existing Unified Messaging (UM) auto attendant that's enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the Disable-UMCallAnsweringRule cmdlet to disable a call answering rule that has been created within a UM-enabled mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the Disable-UMIPGateway cmdlet to disable a Unified Messaging (UM) IP gateway.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-UMMailbox

This cmdlet is available only in on-premises Exchange.

Use the Disable-UMMailbox cmdlet to disable Unified Messaging (UM) for UM-enabled mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-UMServer

This cmdlet is available only in Exchange Server 2010.

Use the Disable-UMServer cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to disabled. This prevents the Unified Messaging server from processing UM calls.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-UMService

This cmdlet is available only in on-premises Exchange.

Use the Disable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging server to disabled. This prevents the UM server from processing UM incoming calls.

You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to disable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the Enable-UMAutoAttendant cmdlet to enable an existing Unified Messaging (UM) auto attendant that's disabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the Enable-UMCallAnsweringRule cmdlet to enable a call answering rule that has been created within a UM-enabled mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the Enable-UMIPGateway cmdlet to enable a Unified Messaging (UM) IP gateway.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMMailbox

This cmdlet is available only in on-premises Exchange.

Use the Enable-UMMailbox cmdlet to enable Unified Messaging (UM) for existing mailbox users.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMServer

This cmdlet is available only in Exchange Server 2010.

Use the Enable-UMServer cmdlet to set the status of a Unified Messaging (UM) server to enabled. This enables the Unified Messaging server to process UM calls.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-UMService

This cmdlet is available only in on-premises Exchange.

Use the Enable-UMService cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to enabled. This setting enables the Unified Messaging server to process UM calls.

You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to enable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-UMCallDataRecord

This cmdlet is available only in on-premises Exchange.

Use the Export-UMCallDataRecord cmdlet to export Unified Messaging (UM) call data records for UM dial plans and UM IP gateways for a date that you've specified.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Export-UMPrompt

This cmdlet is available only in on-premises Exchange.

Use the Export-UMPrompt cmdlet to export an audio file being used as a greeting prompt for Unified Messaging (UM) dial plans and auto attendants.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OnlineMeetingConfiguration

This cmdlet is functional only in the cloud-based service.

Use the Get-OnlineMeetingConfiguration cmdlet to view status and usage information about Skype Meetings and Skype for Business Online for mailboxes. Skype Meetings automatically includes Skype for Business Online conference join information in Exchange Online meeting invitations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMActiveCalls

This cmdlet is available only in on-premises Exchange.

Use the Get-UMActiveCalls cmdlet to return information about the calls that are active and being processed by the Mailbox server running the Microsoft Exchange Unified Messaging service.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the Get-UMAutoAttendant cmdlet to retrieve the properties and the values for a Unified Messaging (UM) auto attendant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the Get-UMCallAnsweringRule cmdlet to view the properties of a Unified Messaging (UM) call answering rule that has been created within a UM-enabled mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMCallDataRecord

This cmdlet is available only in on-premises Exchange.

Use the Get-UMCallDataRecord cmdlet to display Unified Messaging (UM) call data records for a specific UM-enabled user's mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMCallRouterSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-UMCallRouterSettings cmdlet to view the settings of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMCallSummaryReport

This cmdlet is available only in on-premises Exchange.

Use the Get-UMCallSummaryReport cmdlet to return statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMDialPlan

This cmdlet is available only in on-premises Exchange.

Use the Get-UMDialPlan cmdlet to display the properties of a single Unified Messaging (UM) dial plan or to return a list of all UM dial plans associated with Mailbox servers running the Microsoft Exchange Unified Messaging service.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMHuntGroup

This cmdlet is available only in on-premises Exchange.

Use the Get-UMHuntGroup cmdlet to display the properties and values for an existing Unified Messaging (UM) hunt group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the Get-UMIPGateway cmdlet to return a list of properties and values for a specified Unified Messaging (UM) IP gateway or a list of UM IP gateways.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMMailbox

This cmdlet is available only in on-premises Exchange.

Use the Get-UMMailbox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMMailboxPIN

This cmdlet is available only in on-premises Exchange.

Use the Get-UMMailboxPIN cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMMailboxPolicy

This cmdlet is available only in on-premises Exchange.

Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UmServer

This cmdlet is available only in Exchange Server 2010.

Use the Get-UMServer cmdlet to view settings that are associated with the Unified Messaging (UM) server role.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UMService

This cmdlet is available only in on-premises Exchange.

Use the Get-UMService cmdlet to view the settings of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-UMPrompt

This cmdlet is available only in on-premises Exchange.

Use the Import-UMPrompt cmdlet to copy or upload a custom audio file to be used by Unified Messaging (UM) dial plans and auto attendants.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the New-UMAutoAttendant cmdlet to create a Unified Messaging (UM) auto attendant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the New-UMCallAnsweringRule cmdlet to create a call answering rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMDialPlan

This cmdlet is available only in on-premises Exchange.

Use the New-UMDialPlan cmdlet to create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMHuntGroup

This cmdlet is available only in on-premises Exchange.

Use the New-UMHuntGroup cmdlet to create a Unified Messaging (UM) hunt group used to link incoming calls to a specific UM dial plan.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the New-UMIPGateway cmdlet to create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UMMailboxPolicy

This cmdlet is available only in on-premises Exchange.

Use the New-UMMailboxPolicy cmdlet to create a Unified Messaging (UM) mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMAutoAttendant cmdlet to delete a Unified Messaging (UM) auto attendant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMCallAnsweringRule cmdlet to remove an existing Unified Messaging (UM) call answering rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMDialPlan

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMDialPlan cmdlet to delete an existing Unified Messaging (UM) dial plan.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMHuntGroup

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMHuntGroup cmdlet to remove and delete an existing Unified Messaging (UM) hunt group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMIPGateway cmdlet to delete a Unified Messaging (UM) IP gateway.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UMMailboxPolicy

This cmdlet is available only in on-premises Exchange.

Use the Remove-UMMailboxPolicy cmdlet to delete a Unified Messaging (UM) mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMAutoAttendant

This cmdlet is available only in on-premises Exchange.

Use the Set-UMAutoAttendant cmdlet to modify an existing Unified Messaging (UM) auto attendant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMCallAnsweringRule

This cmdlet is available only in on-premises Exchange.

Use the Set-UMCallAnsweringRule cmdlet to change properties of an existing UM call answering rule.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMCallRouterSettings

This cmdlet is available only in on-premises Exchange.

Use the Set-UMCallRouterSettings cmdlet to modify the configuration of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMDialPlan

This cmdlet is available only in on-premises Exchange.

Use the Set-UMDialPlan cmdlet to set various properties on a Unified Messaging (UM) dial plan.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMIPGateway

This cmdlet is available only in on-premises Exchange.

Use the Set-UMIPGateway cmdlet to modify the configuration settings for a single Unified Messaging (UM) IP gateway or to return a list of configuration settings that can be modified on a specified UM IP gateway.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMMailbox

This cmdlet is available only in on-premises Exchange.

Use the Set-UMMailbox cmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMMailboxPIN

This cmdlet is available only in on-premises Exchange.

Use the Set-UMMailboxPIN cmdlet to reset the PIN for a Unified Messaging (UM)-enabled mailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMMailboxPolicy

This cmdlet is available only in on-premises Exchange.

Use the Set-UMMailboxPolicy cmdlet to modify a Unified Messaging (UM) mailbox policy.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UmServer

This cmdlet is available only in Exchange Server 2010.

Use the Set-UMServer cmdlet to modify settings that are associated with the Unified Messaging (UM) server role.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UMService

This cmdlet is available only in on-premises Exchange.

Use the Set-UMService cmdlet to modify the properties of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Test-UMConnectivity

This cmdlet is available only in on-premises Exchange.

Use the Test-UMConnectivity cmdlet to test the operation of Unified Messaging (UM) servers.

Note: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

users-and-groups

Add-DistributionGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-DistributionGroupMember cmdlet to add a single recipient to distribution groups and mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Add-UnifiedGroupLinks

This cmdlet is available only in the cloud-based service.

Use the Add-UnifiedGroupLinks cmdlet to add members, owners and subscribers to Microsoft 365 Groups in your cloud-based organization. To remove members, owners, and subscribers, use the Remove-UnifiedGroupLinks cmdlet. To modify other properties of Microsoft 365 Groups, use the Set-UnifiedGroup cmdlet.

Note: You can't use this cmdlet to modify Microsoft 365 Group members, owners, or subscribers if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see Group resource type.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-DistributionGroup

This cmdlet is available only in on-premises Exchange.

Use the Disable-DistributionGroup cmdlet to remove email capabilities from existing mail-enabled security groups and distribution groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-MailContact

This cmdlet is available only in on-premises Exchange.

Use the Disable-MailContact cmdlet to remove email capabilities from existing mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Disable-MailUser

This cmdlet is available only in on-premises Exchange.

Use the Disable-MailUser cmdlet to remove email capabilities from existing mail users.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-DistributionGroup

This cmdlet is available only in on-premises Exchange.

Use the Enable-DistributionGroup cmdlet to mail-enable existing universal security groups and universal distribution groups that aren't already mail-enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-MailContact

This cmdlet is available only in on-premises Exchange.

Use the Enable-MailContact cmdlet to add email capabilities to existing contacts that aren't already mail-enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-MailUser

This cmdlet is available only in on-premises Exchange.

Use the Enable-MailUser cmdlet to mail-enable existing users that aren't already mail-enabled.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Contact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-Contact cmdlet to view existing contact objects in your organization. This cmdlet returns contacts and mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-DistributionGroup cmdlet to view existing distribution groups or mail-enabled security groups. To view the members of a group, use the Get-DistributionGroupMember cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DistributionGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DynamicDistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-DynamicDistributionGroup cmdlet to view existing dynamic distribution groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-DynamicDistributionGroupMember

This cmdlet is available only in the cloud-based service.

Use the Get-DynamicDistributionGroupMember cmdlet to view the calculated membership list that's stored on dynamic distribution group objects. The results from this cmdlet are updated every 24 hours.

Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-EligibleDistributionGroupForMigration

This cmdlet is functional only in the cloud-based service.

Use the Get-EligibleDistributionGroupForMigration cmdlet to identify distribution groups that can be upgraded to Microsoft 365 Groups. You can't upgrade mail-enabled security groups to Microsoft 365 Groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Group

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-Group cmdlet to view existing group objects in your organization. In all environments, this cmdlet returns mail-enabled security groups, distribution groups, role groups, and room lists. For details about other supported group types in on-premises Exchange environments, see the RecipientTypeDetails parameter description.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-LinkedUser

This cmdlet is available only in the cloud-based service.

Use the Get-LinkedUser cmdlet to view existing linked user accounts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailContact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailContact cmdlet to view existing mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MailUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailUser cmdlet to view mail users and also guest users for Microsoft 365 Groups in cloud environments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-Recipient

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-Recipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).

Note: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipient cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell.

In cloud environments, to return Microsoft 365 Groups, you need to use the RecipientTypeDetails parameter with the value GroupMailbox.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SecurityPrincipal

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UnifiedGroup

This cmdlet is available only in the cloud-based service.

Use the Get-UnifiedGroup cmdlet to view Microsoft 365 Groups in your cloud-based organization. To view members, owners and subscribers for Microsoft 365 Groups, use the Get-UnifiedGroupLinks cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-UnifiedGroupLinks

This cmdlet is available only in the cloud-based service.

Use the Get-UnifiedGroupLinks cmdlet to view membership and ownership information for Microsoft 365 Groups in your cloud-based organization. To view other properties for Microsoft 365 Groups, use the Get-UnifiedGroup cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-User

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-User cmdlet to view existing user objects in your organization. This cmdlet returns all objects that have user accounts (for example, user mailboxes, mail users, and user accounts).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-DistributionGroup cmdlet to create distribution groups and mail-enabled security groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-DynamicDistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-DynamicDistributionGroup cmdlet to create dynamic distribution groups. A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailContact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailContact cmdlet to create mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-MailUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-MailUser cmdlet to create mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-UnifiedGroup

This cmdlet is available only in the cloud-based service.

Use the New-UnifiedGroup cmdlet to create Microsoft 365 Groups in your cloud-based organization. To add members, owners, and subscribers to Microsoft 365 Groups, use the Add-UnifiedGroupLinks cmdlet.

Note: You can't use this cmdlet to create Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see Create group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-DistributionGroup cmdlet to remove distribution groups and mail-enabled security groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DistributionGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-DistributionGroupMember cmdlet to remove a single member from distribution groups or mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-DynamicDistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-DynamicDistributionGroup cmdlet to delete dynamic distribution groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailContact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailContact cmdlet to delete existing mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-MailUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-MailUser cmdlet to remove existing mail users.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UnifiedGroup

This cmdlet is available only in the cloud-based service.

Use the Remove-UnifiedGroup cmdlet to remove Microsoft 365 Groups from your cloud-based organization.

Note: You can't use this cmdlet to remove Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see Delete group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Remove-UnifiedGroupLinks

This cmdlet is available only in the cloud-based service.

Use the Remove-UnifiedGroupLinks cmdlet to remove members, owners and subscribers from Microsoft 365 Groups in your cloud-based organization. To add members, owners and subscribers, use the Add-UnifiedGroupLinks cmdlet. To modify other properties of Microsoft 365 Groups, use the Set-UnifiedGroup cmdlet.

Note: You can't use this cmdlet to modify Microsoft 365 Group members, owners, or subscribers if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see Group resource type.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Contact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-Contact cmdlet to modify contact object settings. If the contact is a mail contact, you can use the Set-MailContact cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Contact cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-DistributionGroup cmdlet to modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DynamicDistributionGroup

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-DynamicDistributionGroup cmdlet to modify existing dynamic distribution groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-Group

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-Group cmdlet to modify group object settings. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Group cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-LinkedUser

This cmdlet is available only in the cloud-based service.

Use the Set-LinkedUser cmdlet to modify the properties of an existing linked user account. The Outlook Live Directory Sync (OLSync) service account is a linked user.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailContact

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailContact cmdlet to modify existing mail contacts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailUser

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailUser cmdlet to modify mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-UnifiedGroup

This cmdlet is available only in the cloud-based service.

Use the Set-UnifiedGroup cmdlet to modify Microsoft 365 Groups in your cloud-based organization. To modify members, owners, and subscribers of Microsoft 365 Groups, use the Add-UnifiedGroupLinks and Remove-UnifiedGroupLinks cmdlets.

Important: You can't use this cmdlet to remove all Microsoft Online Email Routing Address (MOERA) addresses from the Microsoft 365 Group. There must be at least one MOERA address attached to a group. To learn more about MOERA addresses, see How the proxyAddresses attribute is populated in Microsoft Entra ID.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-User

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-User cmdlet to modify user attributes. You can use this cmdlet to modify all objects that have user accounts (for example, user mailboxes, mail users, and user accounts).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Undo-SoftDeletedUnifiedGroup

This cmdlet is available only in the cloud-based service.

Use the Undo-SoftDeletedUnifiedGroup cmdlet to restore soft-deleted Microsoft 365 Groups in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Update-DistributionGroupMember

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Update-DistributionGroupMember cmdlet to replace all members of distribution groups and mail-enabled security groups. To add or remove existing group members, use the Add-DistributionGroupMember and Remove-DistributionGroupMember cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Upgrade-DistributionGroup

This cmdlet is available only in the cloud-based service.

Use the Upgrade-DistributionGroup cmdlet to upgrade distribution groups to Microsoft 365 Groups. This cmdlet only works on distribution groups, not mail-enabled security groups.

Note: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Microsoft 365 Groups.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.