Remove-DSEntry

2024-10-28

Remove-DSEntry

SYNOPSIS

Remove a specified entry from the database.

SYNTAX

__AllParameterSets

Remove-DSEntry -EntryID <guid> [-AsLegacyResponse] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Remove an entry specified by its id from the database.

EXAMPLES

EXAMPLE

PS C:> Remove-DSEntry -EntrID $id

Delete the entry whose ID is stored in $id

PARAMETERS

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

-EntryID

ID of the entry to delete

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- CandidEntryID
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  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.

INPUTS

OUTPUTS

RemoteDesktopManager.PowerShellModule.Private.ServerResponse

NOTES

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

RELATED LINKS

• Get-DSEntry