Item

Synopsis

Remove client list entries.

Syntax

Remove-ClientListItem -Name <String> -Items <Object[]> [-Operation <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Remove-ClientListItem -Name <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Remove-ClientListItem -ListID <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Remove-ClientListItem -ListID <String> -Items <Object[]> [-Operation <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Remove items from a client list. Items to be removed can be provided through the pipeline, or you can provide the entire request body. You can specify the list by its name or ID.

Parameters

`‑AccountSwitchKey`	StringPipeline input: False An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
`‑Body` Conditionally required	ObjectParameter sets: `ID & body`, `Name & body`Pipeline input: False A request body, either as a `PSCustomObject` or a string. This parameter supports pipelining.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑Items` Conditionally required	Object[]Parameter sets: `ID & items`, `Name & items`Pipeline input: ByValue The entry values to import into a client list. Can be an array or a comma-separated string.
`‑ListID` Conditionally required	StringParameter sets: `ID & body`, `ID & items`Pipeline input: False Your client list's ID.
`‑Name` Conditionally required	StringParameter sets: `Name & body`, `Name & items`Pipeline input: False Your client list's name.
`‑Operation`	StringParameter sets: `ID & items`, `Name & items`Pipeline input: False Whether to `append` or `delete` the provided list items to or from those that exist, or `replace` the existing items with those provided.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.

Related Links

Updated 14 days ago