Client settings
Set-PropertyClientSettings
Synopsis
Update client settings.
Syntax
Set-PropertyClientSettings [-RuleFormat] <String> [-UsePrefixes] <Boolean> [[-UpgradeRules] <Boolean>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Updates the current set of default values that apply to API clients keyed by the current authorization token. You can use this function to disable the use of prefixes in the Property API, which is recommended.
Parameters
‑AccountSwitchKey |
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. |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑RuleFormat Required |
The name of the rule format. The rule format can be frozen to a specific version, or represent the |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑UpgradeRules |
When this switch parameter is present, PAPI upgrades the input rule tree object to ensure backward compatibility. You can continuously use the latest rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. Upgrade applies renames, and transformations, fills in default values for new features, and removes extraneous options. New PAPI users have this set to |
‑UsePrefixes Required |
When enabled, the ID values in response data feature three-letter prefixes to indicate their type. You can set the |
Related Links
Updated 9 days ago