Namespace

Set-EdgeKVNamespace

Synopsis

Update namespace details.

Syntax

body (Default)

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

attributes

Set-EdgeKVNamespace -Network <String> -NamespaceID <String> -Name <String> -RetentionInSeconds <Int32>
 -GroupID <Int32> [-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

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

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

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

-GroupID

Unique identifier for an EdgeKV access group.

Type: Int32
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Friendly name of the token. Used when retrieving tokens by name.

Type: String
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
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: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RetentionInSeconds

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.

Type: Int32
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
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: Named
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

System.Object

Outputs