List item
Add-ClientListItem
Synopsis
Import items to a list.
Syntax
name-items (Default)
Add-ClientListItem -Name <String> -Action <String> -Items <Object> -Version <String> [-DryRun] [-IncludeStatus]
[-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
name-file
Add-ClientListItem -Name <String> -Action <String> -Version <String> -File <String> -ListType <String>
[-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
id-file
Add-ClientListItem -ListID <String> -Action <String> -Version <String> -File <String> -ListType <String>
[-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
id-items
Add-ClientListItem -ListID <String> -Action <String> -Items <Object> -Version <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
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
-Action
Merges or replaces specified items, either MERGE
or REPLACE
.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: MERGE, REPLACE
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DryRun
Executes the request as a dry run, without saving.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
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
-File
CSV file from which to read list items.
Type: String
Parameter Sets: name-file, id-file
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeStatus
Include request metadata in the response. Without this only the updated list items will be returned.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Items
Entry values to import into a client list. It 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: False
Accept wildcard characters: False
-ListID
Unique identifier for each client list.
Type: String
Parameter Sets: id-file, id-items
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ListType
Type of your client list, which can be IP
, GEO
, ASN
, TLS_FINGERPRINT
, or FILE_HASH
.
Type: String
Parameter Sets: name-file, id-file
Aliases:
Accepted values: IP, GEO, ASN, TLS_FINGERPRINT, FILE_HASH
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-file
Aliases: None
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
-Version
The version of your client list. Can be an integer or the word latest
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
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
None
Outputs
System.Object
Related links
Updated 9 days ago