Guide

List item

Get-ClientListItem

Suggest Edits

Synopsis

Get client list entries.

Syntax

Get-ClientListItem [-Name] <String> [-Include <String>] [-Search <String>] [-Page <Int32>] [-PageSize <Int32>] [-Sort <String>] [-IncludeMetadata] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-ClientListItem -ListID <String> [-Include <String>] [-Search <String>] [-Page <Int32>] [-PageSize <Int32>] [-Sort <String>] [-IncludeMetadata] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets the entries of a specific client list. 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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Include
String Pipeline input: False

Specifies which client lists should appear in the response: ACTIVE, INACTIVE, or the default ALL.
‑IncludeMetadata
Switch Pipeline input: False

Include request metadata in the response. Without this, only the response content object will be returned.
‑ListID
Conditionally required
String Parameter sets: id Pipeline input: False

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

Your client list's name.
‑Page
Int Pipeline input: False

The request page number for a paginated output, starting from the default 0.
‑PageSize
Int Pipeline input: False

Number of entries in paginated output. The default page size is 10.
‑Search
String Pipeline input: False

Returns results that match the specified substring in any client list's details or entry details.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Sort
String Pipeline input: False

Sorts your collection of client lists by property and order (ASC, DESC). Case-insensitive, repeatable parameter.

Related Links

Updated 10 days ago