Client list

Set-ClientList

Synopsis

Update client list details.

Syntax

Set-ClientList -Name <String> -NewName <String> [-Notes <String>] [-Tags <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-ClientList -Name <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-ClientList -ListID <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-ClientList -ListID <String> -NewName <String> [-Notes <String>] [-Tags <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the name, notes, and tags of a client list. When you update tags, the updated tag list replaces the existing one. You can specify the list by either its name or ID.

Parameters

‑AccountSwitchKey

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

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑ListID
Conditionally required

Your client list's ID.

‑Name
Conditionally required

Your client list's name.

‑NewName
Conditionally required

A new name for your client list.

‑Notes

Any additional notes you want to add about your client list.

‑Section

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

‑Tags

The tags you want to add to your client list.

Related Links