Item

Get-EdgeKVItem

Synopsis

Read an item.

Syntax

Get-EdgeKVItem [-Network] <String> [-NamespaceID] <String> [[-GroupID] <Int32>] [[-ItemID] <String>]
 [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all EdgeKV items for a given network, namespace, and group or returns a specific item by its ID. For the list, the operation returns up to 100 items by default or the number of items specified in the -MaxItems parameter.

Items recently written to EdgeKV can take 10 seconds or longer to read and you may get a 404 error during that period.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 6
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: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Unique identifier for an EdgeKV access group.

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

-ItemID

Unique identifier for each item. The key of a key-value pair.

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

-NamespaceID

Unique identifier for each namespace.

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

-Network

Network environment to execute the API request on.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: STAGING, PRODUCTION

Required: True
Position: 0
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: 5
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