Note: PowerShell integration requires a ShareGate Migrate Pro or Enterprise subscription. It is not available on the Essentials plan.
Command
Get-ChatUser
Description
Get-ChatUser retrieves the Microsoft Teams users available for a chat migration. Use -Id, -Name, or -EmailAddress to look up specific users, or run the command without any of them to list all available users.
Examples
Get a chat user by ID
$connection = Connect-MicrosoftOnline -CopyFeature ChatCopy
$userId = "0bc4c795-fc91-4920-b3dd-bb33c4e2e6cd"
Get-ChatUser -Id $userId -Connection $connection
Get multiple chat users by ID
$connection = Connect-MicrosoftOnline -CopyFeature ChatCopy
$userIds = "0bc4c795-fc91-4920-b3dd-bb33c4e2e6cd", "4b54a732-7259-44bd-aaac-2dca7a5335d0"
Get-ChatUser -Id $userIds -Connection $connection -AllowMultiple
Get a chat user by name
$connection = Connect-MicrosoftOnline -CopyFeature ChatCopy
Get-ChatUser -Name "Adele Vance" -Connection $connection
Get a chat user by email address
$connection = Connect-MicrosoftOnline -CopyFeature ChatCopy
Get-ChatUser -EmailAddress "[email protected]" -Connection $connection
Get all chat users
$connection = Connect-MicrosoftOnline -CopyFeature ChatCopy
Get-ChatUser -Connection $connection -AllowMultiple
Syntax
Get-ChatUser
-Connection <IConnection>
[-AllowMultiple]
Get-ChatUser
-Name <String[]>
-Connection <IConnection>
[-AllowMultiple]
Get-ChatUser
-Id <String[]>
-Connection <IConnection>
[-AllowMultiple]
Get-ChatUser
-EmailAddress <String[]>
-Connection <IConnection>
[-AllowMultiple]
Parameters
-AllowMultiple <SwitchParameter>
Specifies that multiple chat users can be returned by the command.
Required? | False |
Default value | None |
Accept pipeline input? | False |
Accept wildcard characters? | False |
Parameter set name | (All) |
Aliases | None |
-Connection <IConnection>
Specifies the source tenant connection.
Required? | True |
Default value | None |
Accept pipeline input? | True (ByValue) |
Accept wildcard characters? | False |
Parameter set name | (All) |
Aliases | None |
-EmailAddress <String[]>
Specifies the email address of the chat user (wildcards supported).
Required? | True |
Default value | System.String[] |
Accept pipeline input? | False |
Accept wildcard characters? | True |
Parameter set name | EmailAddress |
Aliases | None |
-Id <String[]>
Specifies the ID of the chat user.
Required? | True |
Default value | System.String[] |
Accept pipeline input? | False |
Accept wildcard characters? | False |
Parameter set name | Id |
Aliases | None |
-Name <String[]>
Specifies the display name of the chat user (wildcards supported).
Required? | True |
Default value | System.String[] |
Accept pipeline input? | False |
Accept wildcard characters? | True |
Parameter set name | Name |
Aliases | None |