Akamai options

Set-AkamaiOptions

Synopsis

Update Akamai Options.

Syntax

Set-AkamaiOptions [-EnableErrorRetries <Boolean>] [-InitialErrorWait <Int32>] [-MaxErrorRetries <Int32>] [-EnableRateLimitRetries <Boolean>] [-EnableRateLimitWarnings <Boolean>] [-RateLimitWarningPercentage <Int32>] [-DisablePAPIPrefixes <Boolean>] [-EnableRecommendedActions <Boolean>] [-EnableDataCache <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-AkamaiOptions [-RestoreDefaults] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates any of the supported Akamai options, either as booleans to enable or disable certain features, for example, -EnableErrorRetried $true, or as integers to set various thresholds and limits, for example, -MaxErrorRetries 2. You can also reset all options to their defaults with -RestoreDefaults.

Note: You can't set any options and restore the others to default in a single command. You need to restore the defaults first, then set whatever options you wish.

Parameters

-DisablePAPIPrefixes

Forces the addition of a header disabling prefixes in all Property API calls, regardless of API client setting.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableDataCache

Enables the in-memory data cache feature, which caches resolution of names to IDs and speeds up subsequent API calls.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableErrorRetries

Enables retries for applicable requests when the API endpoint responds with a 5XX status code.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableRateLimitRetries

Enables retries for applicable requests when the API endpoint responds with a 429 status code.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableRateLimitWarnings

Enables outputting a warning when you have reached a set percentage of your rate limit, e.g. if the limit is 500 requests, your warning percentage is 80 and you have expended 400 requests, any further requests before the rate limit repleneshes will result in a warning being printed to the shell.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableRecommendedActions

Enables the recommended actions provider, which will suggest actions in the event of certain errors. This feature requires the use of the PSFeedbackProvider Powershell experimental feature, and currently has an extremely limited scope.

Type: Boolean
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InitialErrorWait

Set the initial wait time (in seconds) after which PowerShell will retry an applicable request.

Type: Int32
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxErrorRetries

Set the maximum number of retries which will be attempted for applicable requests in the event of an error.

Type: Int32
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RateLimitWarningPercentage

Set the percentage used of the rate limit for a given endpoint, above which PowerShell will warn you of rate limit exhaustion.

Type: Int32
Parameter Sets: SetOptions
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RestoreDefaults

Restore Akamai options to the default values.

Type: SwitchParameter
Parameter Sets: Default
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False