Muokkaa

Jaa

Enable or disable access to Exchange Online PowerShell

  • Artikkeli

Exchange Online PowerShell is the administrative interface that enables admins to manage the Exchange Online part of a Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365).

By default, all accounts in Microsoft 365 are allowed to use Exchange Online PowerShell. This access doesn't give users administrative capabilities. They're still limited by role based access control (RBAC). For example, they can configure some settings on their own mailbox and manage distribution groups that they own, but not much else.

Admins can use the procedures in this article to disable or enable a user's ability to connect to Exchange Online PowerShell.

What do you need to know before you begin?

  • Estimated time to complete each procedure: less than 5 minutes

  • The procedures in this article are available only in Exchange Online PowerShell. To connect to Exchange Online PowerShell, see Connect to Exchange Online PowerShell.

  • You need to be assigned permissions before you can do the procedures in this article. You have the following options:

    • Exchange Online RBAC: Membership in the Organization Management or Recipient Management role groups.
    • Microsoft Entra RBAC: Membership in the Exchange Administrator or Global Administrator* roles gives users the required permissions and permissions for other features in Microsoft 365.

    Important

    In your haste to quickly and globally disable PowerShell access in your cloud-based organization, beware of commands like Get-User | Set-User -EXOModuleEnabled $false without considering admin accounts. Use the procedures in this article to selectively remove PowerShell access, or preserve access for those who need it by using the following syntax in your global removal command: Get-User | Where-Object {$_.UserPrincipalName -ne 'admin1@contoso.onmicrosoft.com' -and $_.UserPrincipalName -ne 'admin2@contoso.onmicrosoft.com'...} | Set-User -EXOModuleEnabled $false.

    If you accidentally lock yourself out of PowerShell access, create a new admin account in the Microsoft 365 admin center, and then use that account to give yourself PowerShell access using the procedures in this article.

    * Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role.

  • For detailed information about OPATH filter syntax in Exchange Online, see Additional OPATH syntax information.

Tip

Having problems? Ask for help in the Exchange forums. Visit the forums at: Exchange Online, or Exchange Online Protection.

Enable or disable access to Exchange Online PowerShell for a user

This example disables access to Exchange Online PowerShell for the user david@contoso.onmicrosoft.com.

Set-User -Identity david@contoso.onmicrosoft.com -EXOModuleEnabled $false

This example enables access to Exchange Online PowerShell for the user chris@contoso.onmicrosoft.com.

Set-User -Identity chris@contoso.onmicrosoft.com -EXOModuleEnabled $true

Disable access to Exchange Online PowerShell for many users

To prevent access to Exchange Online PowerShell for a specific group of existing users, you have the following options:

  • Filter users based on an existing attribute: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes (for example, Title, Department, address information, and telephone number) are available only from the Get-User cmdlet. Other attributes (for example, CustomAttribute1 to CustomAttribute15) are available only from the Get-Mailbox cmdlet.
  • Use a list of specific users: After you generate the list of specific users, you can use that list to disable their access to Exchange Online PowerShell.

Filter users based on an existing attribute

To disable access to Exchange Online PowerShell for any number of users based on an existing attribute, use the following syntax:

$<VariableName> = <Get-Mailbox | Get-User> -ResultSize unlimited -Filter <Filter>

$<VariableName> | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false}

This example removes access to Exchange Online PowerShell for all users whose Title attribute contains the value "Sales Associate".

$DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like 'Sales Associate*')"

$DSA | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false}

Use a list of specific users

To disable access to Exchange Online PowerShell for a list of specific users, use the following syntax:

$<VariableName> = Get-Content <text file>

$<VariableName> | foreach {Set-User -Identity $_ -EXOModuleEnabled $false}

The following example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows:

akol@contoso.onmicrosoft.com
tjohnston@contoso.onmicrosoft.com
kakers@contoso.onmicrosoft.com

After you populate the text file with the user accounts you want to update, run the following commands:

$NoPS = Get-Content "C:\My Documents\NoPowerShell.txt"

$NoPS | foreach {Set-User -Identity $_ -EXOModuleEnabled $false}

View the Exchange Online PowerShell access status for users

Tip

The newer EXOModuleEnabled property isn't available to use with the Filter parameter on the Get-User cmdlet, but the values of the EXOModuleEnabled property and the older RemotePowerShellEnabled property are always the same, so use the RemotePowerShellEnabled property with the Filter parameter on the Get-User cmdlet.

To view the PowerShell access status for a specific user, replace <UserIdentity> with the name or user principal name (UPN) of the user, and run the following command:

Get-User -Identity "<UserIdentity>" | Format-List EXOModuleEnabled

To display the Exchange Online PowerShell access status for all users, run the following command:

Get-User -ResultSize unlimited | Format-Table -Auto DisplayName,EXOModuleEnabled

To display all users who don't have access to Exchange Online PowerShell, run the following command:

Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false'

To display all users who have access to Exchange Online PowerShell, run the following command:

Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true'