Get-DSDeletedUser

Synopsis

Get deleted users.

Syntax

__AllParameterSets

Get-DSDeletedUser [-PageNumber <int>] [-PageSize <int>] [<CommonParameters>]

Description

Retrieve users that have been marked as deleted but not permanently removed. By default, retrieves the first 10 000 results.

Examples

Example 1

PS C:\> Get-DSDeletedUser

Get all deleted users.

Example 2

PS C:\> Get-DSDeletedUser -PageNumber 2 -PageSize 50

Get the second page with 50 users per page.

Example 3

PS C:\> Get-DSDeletedUser | ForEach-Object { Restore-DSDeletedUser -ID $_.ID }

Restore all deleted users.

Example 4

PS C:\> $deletedUser = Get-DSDeletedUser | Where Name -EQ 'johndoe'
PS C:\> Remove-DSDeletedUser -ID $deletedUser.ID

Get a deleted user by username and permanently delete it.

Parameters

-PageNumber

Page number for paginated results. Default: 1

Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageSize

Number of results per page. Default: 10000

Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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.

Outputs

Devolutions.RemoteDesktopManager.Business.Models.UserListItem

Notes

For more information, type "Get-Help Get-DSDeletedUser -detailed". For technical information, type "Get-Help Get-DSDeletedUser -full".