List item

Synopsis

Import entries from a CSV file.

Syntax

Import-ClientListItem -Name <String> -Version <String> -File <String> -Action <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Import-ClientListItem -Name <String> -Version <String> -Items <String[]> -Action <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Import-ClientListItem -ListID <String> -Version <String> -Items <String[]> -Action <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Import-ClientListItem -ListID <String> -Version <String> -File <String> -Action <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds items to a client list in two ways: either as individual items within the -Items parameter (an array of strings or a comma-separated string are accepted) or from a CSV file using the -File parameter.

Your CSV file needs to include these four columns: value, description, tags, and expirationDate.

When making a request, you can specify the client list by either its name or ID. The -Version parameter is an integer or the word latest.

Parameters

`‑AccountSwitchKey`	StringPipeline 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.
`‑Action` Required	StringAccepted values: `MERGE`, `REPLACE`Pipeline input: False Merges or replaces specified items, either `MERGE` or `REPLACE`.
`‑DryRun`	SwitchPipeline input: False Executes the request as a dry run, without saving.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑File` Conditionally required	StringParameter sets: `ID & file`, `Name & file`Pipeline input: False A CSV file from which to read list items.
`‑IncludeStatus`	SwitchPipeline input: False Include request metadata in the response. Without this, only the updated list items will be returned.
`‑Items` Conditionally required	String[]Parameter sets: `ID & items`, `Name & items`Pipeline input: False The entry values to import into a client list. Can be an array or a comma-separated string.
`‑ListID` Conditionally required	StringParameter sets: `ID & items`, `ID & file`Pipeline input: False Your client list's ID.
`‑Name` Conditionally required	StringParameter sets: `Name & items`, `Name & file`Pipeline input: False Your client list's name.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑Version` Required	StringPipeline input: False Your client list's version. Can be an integer or the word `latest`.

Related Links

Updated 4 days ago

Did this page help you?