Keys

Move-APIKey

Synopsis

Move keys.

Syntax

Move-APIKey -KeyIds <Object> -DestinationCollectionID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Move-APIKey -KeyIds <Object> -NewCollectionName <String> [-NewCollectionDescription <String>] -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Moves keys from one collection to another, either an existing one or a new one. If you specify a -DestinationCollectionID in the request, the operation moves the keys to the existing collection.

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.

‑ContractID
Conditionally required

The ID of the contract you assign to the new collection. To get this value, run Get-Contracts from the Akamai.Property module.

‑DestinationCollectionID
Conditionally required

The existing destination collection's ID.

‑EdgeRCFile

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

‑GroupID
Conditionally required

The ID of the group where to create the new collection. To get this value, run Get-Group from the Akamai.Property module.

‑KeyIds
Required

A comma-separated string containing key IDs. You can retrieve these with Get-APIKey.

‑NewCollectionDescription

A human-readable description for the new destination collection. Appears as null in responses until you specify it.

‑NewCollectionName
Conditionally required

A human-readable name you assign to the new destination collection.

‑Section

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

Related Links