Property rule
Add-PropertyRule
Synopsis
Add a rule or setting to a property.
Syntax
Add-PropertyRule [-PropertyName] <String> [-PropertyVersion] <String> -Path <String> -Value <Object> [-VersionNotes <String>] [-RuleFormat <String>] [-UpgradeRules] [-OriginalInput] [-DryRun] [-ValidateMode <String>] [-ValidateRules] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-PropertyRule -PropertyID <String> [-PropertyVersion] <String> -Path <String> -Value <Object> [-VersionNotes <String>] [-RuleFormat <String>] [-UpgradeRules] [-OriginalInput] [-DryRun] [-ValidateMode <String>] [-ValidateRules] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Adds a rule or setting to a property using JSON Patch syntax. This can be a single string or integer, up to an entire rule, including its children. To find the JSONPath rule path, commonly we recommend pairing this command with New-BulkSearch
. The -PropertyVersion
parameter is an integer or the word latest
.
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. |
‑ContractId |
Your contract's ID. The parameter is optional if a property belongs to only one contract; otherwise, you need to specify it along with the |
‑DryRun |
With the |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupID |
Your group's ID. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the |
‑OriginalInput |
When you include this switch, PAPI outputs a property's rule tree in the original form provided by the When you don't include this switch, your original input can include the latest rule changes, such as new options with default values. |
‑Path Required |
An absolute path from the top of the rule tree. |
‑PropertyID Conditionally required |
Your property's ID. Commonly, you only need to specify either |
‑PropertyName Conditionally required |
A human-readable name for your property. Commonly, you only need to specify either |
‑PropertyVersion Required |
Property's incremental version number. Can be an integer or the word |
‑RuleFormat |
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 |
‑ValidateMode |
With |
‑ValidateRules |
When enabled, performs validation tests that would identify potential problems within the response object's |
‑Value Required |
The value to apply to the PATCH operation. Can be as simple as a string or integer, or an entire rule tree, depending on the |
‑VersionNotes |
Notes to add to your property or include version. Note that you can also provide this information as the top-level "comments" object in the rule tree JSON, but if both are present, this parameter takes precedence. |
Related Links
Updated 8 days ago