List item

Set-ClientListItem

Synopsis

Update client list entries.

Syntax

name-items (Default)

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

name-body

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

id-body

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

id-items

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

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

Type: Object
Parameter Sets: name-body, id-body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Items

Entry values to import into a client list. Can be an array or comma-separated string.

Type: Object
Parameter Sets: name-items, id-items
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ListID

Unique identifier for each client list.

Type: String
Parameter Sets: id-body, id-items
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of your client list.

Type: String
Parameter Sets: name-items, name-body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Operation

Whether to append or delete the provided list items to/from those exist, or 'replace' the existing items with those provided.

Type: String
Parameter Sets: name-items, id-items
Aliases:
Accepted values: update, append, delete

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs