Edit

Share via

Remove-EntraUserExtension

Module:
Microsoft.Entra.Users Module v1.1

Removes a user extension.

Syntax

RemoveMultiple 

Remove-EntraUserExtension

    -UserId <String>
    -ExtensionNames <System.Collections.Generic.List`1[System.String]>
    [<CommonParameters>]

RemoveSingle 

Remove-EntraUserExtension

    -UserId <String>
    -ExtensionName <String>
    [<CommonParameters>]

Description

The Remove-EntraUserExtension cmdlet removes a user extension from Microsoft Entra ID. Specify UserId and ExtensionName or ExtensionNames parameters to remove a user extension.

Examples

Example 1: Remove a single user extension

Connect-Entra -Scopes 'User.ReadWrite.All'
Remove-EntraUserExtension -UserId 'SawyerM@Contoso.com' -ExtensionName 'extension_bbbbbbbb111122223333cccccccccccc_TestExtension'

This example demonstrates how to remove a user extension from Microsoft Entra ID.

  • UserId parameter specifies the user ID.
  • ExtensionName parameter specifies the user extension name.

Example 2: Remove multiple user extensions

Connect-Entra -Scopes 'User.ReadWrite.All'
Remove-EntraUserExtension -UserId 'SawyerM@Contoso.com' -ExtensionNames 'extension_bbbbbbbb111122223333cccccccccccc_TestExtension','extension_bbbbbbbb111122223333cccccccccccc_DummyExtension'

This example demonstrates how to remove a user extension from Microsoft Entra ID.

  • UserId parameter specifies the user ID.
  • ExtensionNames parameter specifies a collection user extension names.

Parameters

-ExtensionName

Specifies the name of an extension.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RemoveSingle
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-ExtensionNames

Specifies an array of extension names.

Parameter properties

Type:

System.Collections.Generic.List`1[System.String]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RemoveMultiple
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-UserId

Specifies the ID of a user (as a User Principle Name or UserId) in Microsoft Entra ID.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.