Remove-DSDeletedUserGroup

Synopsis

Permanently delete a deleted user group

Syntax

__AllParameterSets

Remove-DSDeletedUserGroup -ID <guid> [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Permanently delete a user group that has already been marked as deleted. This action cannot be undone.

Examples

Example 1

PS C:\> Remove-DSUserGroup -UserGroupID $userGroupId
PS C:\> Remove-DSDeletedUserGroup -ID $userGroupId

Permanently delete a user group (cannot be undone). Must soft-delete first, then hard-delete.

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

-Confirm

Prompts for confirmation before running the cmdlet.

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

-ID

Id of the deleted user group to permanently remove.

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

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
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.

Notes

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