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 specified client list. When you delete the list, it displays as inactive. You can delete only the list that hasn't been activated yet.

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 18 days ago