Guide

List item

Set-ClientListItem

Suggest Edits

Synopsis

Update client list entries.

Syntax

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

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

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

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

Description

Appends, deletes, and updates the client list entries in a single batch. You can provide items as an array (or via the pipeline), in which you also need to specify the -Operation (update, append, or delete). Alternatively, you can provide the entire request body with the -Body parameter.

When making a request, you can specify the list by its name or ID.

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.
‑Body
Conditionally required
Object Parameter sets: id-body, name-body Pipeline input: False

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑EdgeRCFile
String Pipeline 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
String Parameter sets: id-body, id-items Pipeline input: False

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

Your client list's name.
‑Operation
Conditionally required
String Accepted values: update, append, delete Parameter 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
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