Guide

Keys

Import-APIKey

Suggest Edits

Synopsis

Import keys.

Syntax

Import-APIKey -CollectionID <Int32> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Import-APIKey -CollectionID <Int32> -KeyValue <String> [-KeyDescription <String>] [-Label <String>] [-Tags <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Import-APIKey -CollectionID <Int32> [-InputFile <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Imports keys to a given collection. You can import keys from a PSCustomObject or JSON string, or you can specify -InputFile as either json, csv, or xml.

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.
‑CollectionID
Required
Int Pipeline input: False

Your collection's ID. Run Get-APIKeyCollection to retrieve collections available to you.
‑EdgeRCFile
String Pipeline input: False

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

A local file containing keys. Must use either the json, csv, or xml file extension.
‑KeyDescription
String Parameter sets: attributes Pipeline input: False

A human-readable description for the key you want to create.
‑KeyValue
Conditionally required
String Parameter sets: attributes Pipeline input: False

The value for the key you want to create.
‑Label
String Parameter sets: attributes Pipeline input: False

The label assigned to the key.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Tags
String Parameter sets: attributes Pipeline input: False

A comma-separated string containing additional categories assigned to the key that you can use as filters.

Related Links

Updated 4 days ago