Guide
  1. API Key Manager
  2. Set

Throttling counter

Synopsis

Edit a throttling counter.

Syntax

Set-APIThrottlingCounter [-CounterID] <Int32> [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates information about a throttling counter. As the request body for this function can be quite complex, it is recommended to retrieve the existing collection with Get-APIThrottlingCounter, edit locally, and pipe the result to this function. When piping the counter as a PSCustomObject, you can read the CollectionID from the pipeline, so you don't need to specify it separately.

Parameters

‑AccountSwitchKey
StringPipeline 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
Required
ObjectPipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑CounterID
Required
IntPipeline input: ByPropertyName

The throttling counter's ID. Run Get-APIThrottlingCounter without the -CounterID to list counters and select one.

‑EdgeRCFile
StringPipeline input: False

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

‑Section
StringPipeline input: False

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

Related Links

Updated 3 months ago