Item

New-EdgeKVItem

Synopsis

Write an EdgeKV item.

Syntax

New-EdgeKVItem [-Network] <String> [-NamespaceID] <String> [[-GroupID] <Int32>] [-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.

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

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: 7
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: 5
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: True
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: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

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

Type: Object
Parameter Sets: (All)
Aliases: None
Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByValue)
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