Keys

Move-APIKey

Synopsis

Move keys.

Syntax

existing (Default)

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

new

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey 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

-ContractID

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

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

-DestinationCollectionID

Identifies the existing destination collection.

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

-GroupID

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

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

-KeyIds

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

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

-NewCollectionDescription

Description for the new destination collection. Appears as null in responses until you specify it.

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

-NewCollectionName

Name you assign to the new destination collection.

Type: String
Parameter Sets: new
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