Item

Get-EdgeKVItem

Synopsis

Read an item.

Syntax

Get-EdgeKVItem -Network <String> -NamespaceID <String> -GroupID <String> [-SandboxID <String>] [-MaxItems <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-EdgeKVItem -Network <String> -NamespaceID <String> -GroupID <String> [-ItemID <String>] [-SandboxID <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

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

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID
Required

Your EdgeKV access group's ID.

‑ItemID

An item's ID. The key of a key-value pair.

‑MaxItems

If specified, maximum number of items to return per request, up to the system limits.

‑NamespaceID
Required

A namespace's ID.

‑Network
Required

The type of network to execute the API request on, either STAGING or PRODUCTION.

‑SandboxID

Accesses EdgeKV data in the specified sandbox environment. To list existing sandbox identifiers, run the Sandbox API's List sandboxes operation.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links