Property
Synopsis
Create or clone a property.
Syntax
Copy-Property -Name <String> -ProductID <String> [-RuleFormat <String>] -ClonePropertyName <String> -ClonePropertyVersion <String> [-ClonePropertyVersionEtag <String>] [-CopyHostnames] [-UseHostnameBucket] -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Copy-Property -Name <String> -ProductID <String> [-RuleFormat <String>] -ClonePropertyID <String> -ClonePropertyVersion <String> [-ClonePropertyVersionEtag <String>] [-CopyHostnames] [-UseHostnameBucket] -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Copy-Property -Body <Object> -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Description
This operation either creates a new property from scratch or bases one on another property's rule tree and optionally its set of assigned hostnames.
Version 1 of a new property is created automatically.
PAPI's ability to create and clone new properties means that you can design a system of rule templates targeted to specific domains, rather than maintain a single set of rules with conditional logic for your full range of domains.
Maintaining properties manually within the Control Center interface limited you to that more consolidated approach, but you can deploy rules more efficiently using PAPI.
In either case, PAPI makes it much easier for you to support a large, flexible set of domains.
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. |
‑BodyConditionally required | A request body, either as a |
‑ClonePropertyIDConditionally required | The ID of the property to clone. If cloning a property, provide this or the |
‑ClonePropertyNameConditionally required | The name of the property to clone. If cloning a property, provide this or the |
‑ClonePropertyVersionConditionally required | The version of the property to clone. Can be an integer or the word |
‑ClonePropertyVersionEtag | Performs an ETag data integrity check on the original property version to ensure no edits have occurred since your last check. |
‑ContractIDRequired | 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 |
‑CopyHostnames | Assigns the same set of hostnames to the new property. |
‑EdgeRCFile | Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupIDRequired | 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 |
‑NameConditionally required | A human-readable name you give to identify your property. |
‑ProductIDConditionally required | The product's ID. |
‑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 |
‑UseHostnameBucket | When the switch is present, this creates a special type of property where you can add or remove property hostnames without incrementing property versions. Generally used for properties with > 1000 hostnames. |
Related Links
Updated 12 days ago