Guide

Key collection

New-APIKeyCollection

Suggest Edits

Synopsis

Create a key collection.

Syntax

New-APIKeyCollection -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-APIKeyCollection -CollectionName <String> [-CollectionDescription <String>] -ContractID <String> -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates an empty collection under the selected contract and group.

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.
‑CollectionDescription
String Parameter sets: attributes Pipeline input: False

A human-readable description for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.
‑CollectionName
Conditionally required
String Parameter sets: attributes Pipeline input: False

A human-readable name for the collection.
‑ContractID
Conditionally required
String Parameter sets: attributes Pipeline input: False

The ID of the contract you assign to the new collection. To get this value, run Get-Contracts from the Akamai.Property module.
‑EdgeRCFile
String Pipeline input: False

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

The ID of the group where to create the new collection. To get this value, run Get-Group from the Akamai.Property module.
‑Section
String Pipeline input: False

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

Related Links

Updated 8 days ago