Get-DSDeletedUserGroup

Synopsis

Get deleted user groups

Syntax

__AllParameterSets

Get-DSDeletedUserGroup [[-Name] <string>] [-PageSize <int>] [-CaseSensitive] [<CommonParameters>]

Description

Retrieve user groups that have been marked as deleted but not permanently removed. Retrieves all results across every page.

Examples

Example 1

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

Restore all deleted user groups

Example 2

PS C:\> $deletedUserGroup = Get-DSDeletedUserGroup -Name 'Administrators'
PS C:\> Remove-DSDeletedUserGroup -ID $deletedUserGroup.ID

Get a deleted user group by name and permanently delete it

Parameters

-CaseSensitive

Case sensitive search.

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

-Name

Filter the deleted user groups by their name.

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

-PageSize

Number of results fetched per page. Default: 10000. Increase this value to reduce the number of requests for large datasets (fewer round trips), or decrease it if you encounter timeout issues due to heavy payloads.

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.RoleListItem

Notes

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