Guide

Namespace

Set-EdgeKVNamespace

Suggest Edits

Synopsis

Update namespace details.

Syntax

Set-EdgeKVNamespace -Network <String> -NamespaceID <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-EdgeKVNamespace -Network <String> -NamespaceID <String> -Name <String> -RetentionInSeconds <Int32> -GroupID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the retention period for any existing namespace other than the default namespace. It can take up to five minutes for a new retention policy to apply.

The new retention period applies only to data added or updated in the namespace after this operation is complete. The retention period of existing data remains unchanged from the old retention period.

Once you perform this operation, you can't query the previously existing data. If you want to ensure that all data in the namespace has the same retention period, you need to update the entire data set once the retention period has been updated.

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.
‑Body
Conditionally required
Object Parameter sets: body Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Conditionally required
String Parameter sets: attributes Pipeline input: False

Your EdgeKV access group's ID.
‑Name
Conditionally required
String Parameter sets: attributes Pipeline input: False

Your token's name. Used when retrieving tokens by name.
‑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.
‑RetentionInSeconds
Conditionally required
Int Parameter sets: attributes Pipeline input: False

A retention period of underlying data, represented in seconds. Accepts values between 86400 for one day and 315360000 for 10 years. You can also enter a value of 0 to retain data indefinitely.
‑Section
String Pipeline input: False

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

Related Links

Updated 11 days ago