Guide

Item

New-EdgeKVItem

Suggest Edits

Synopsis

Write an EdgeKV item.

Syntax

New-EdgeKVItem [-Network] <String> [-NamespaceID] <String> [-GroupID] <String> [-ItemID] <String> [-Value] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates or updates an EdgeKV item (name-value) on a given network. You need to specify the namespace and group to which the item belongs. The target namespace ID needs to already exist before writing. Whereas, the group ID is automatically created for you if it doesn't exist yet.

Note: If you don't specify the group ID, a value of 0 is used, which makes the item available to all groups.

Parameters

‑AccountSwitchKey
String Pipeline 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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Required
String Pipeline input: False

Your EdgeKV access group's ID.
‑ItemID
Required
String Pipeline input: False

An item's ID. The key of a key-value pair.
‑NamespaceID
Required
String Pipeline input: False

A namespace's ID.
‑Network
Required
String Accepted values: STAGING, PRODUCTION Pipeline input: False

The type of network to execute the API request on, either STAGING or PRODUCTION.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Value
Required
Object Pipeline input: ByValue

A value to assign to the new or updated item, can be a string or a PSCustomObject which will be converted to JSON. Supports pipelining.

Related Links

Updated 29 days ago