Guide

Key collection

Remove-APIKeyCollection

Suggest Edits

Synopsis

Delete a key collection.

Syntax

Remove-APIKeyCollection [-CollectionID] <Int32> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Deletes a collection and any keys the collection includes that aren't assigned to other collections. When piping the collection to be removed as a PSCustomObject, you can read the -CollectionID from the pipeline, so you don't need to specify it separately.

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

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.
‑Section
String Pipeline input: False

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

Related Links

Updated 4 months ago