Throttling counter

Set-APIThrottlingCounter

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.

Note: When piping the counter as a PSCustomObject, the CounterID can be read from the pipeline, so it doesn't need to be specified separately.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

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

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

-CounterID

Identifies the throttling counter. Run Get-APIThrottlingCounter without CounterID to list counters and select one.

Type: Int32
Parameter Sets: (All)
Aliases: ThrottlingCounterID

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
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: 3
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.Int32

System.Object

Outputs