Guide

Client list

Remove-ClientList

Suggest Edits

Synopsis

Delete a client list.

Syntax

Remove-ClientList [-Name] <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Remove-ClientList -ListID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Deletes a specific client list. You can only delete a list that is inactive or has been previously deactivated. When you delete a client list, its deprecated value becomes true, and the list remains stored for 90 days before it's permanently deleted. During that time, you can still get its data, but you can't activate it.

Parameters

‑AccountSwitchKey
String Pipeline 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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑ListID
Conditionally required
String Parameter sets: id Pipeline input: ByValue, ByPropertyName

Your client list's ID.
‑Name
Conditionally required
String Parameter sets: name Pipeline input: False

Your client list's name.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 2 days ago