Property Manager

Properties are base configurations that govern your site or application's Akamai setup. Each property contains an Edge Hostname, your traffic and security options, and your business rules.


Use cases

Use the PowerShell module to create and manage your properties, property rules, and property rule includes.

Prefixes

The Property API is unique in the way that it represents all aspects of its resources with a prefix denoting the type by default.

Object              Value            Prefix
------              -----            ------
accountId         : act_1-ABCDEF     act_
contractId        : ctr_1-1GH2IJ     ctr_
groupId           : grp_111111       grp_
propertyId        : prp_555555       prp_
assetId           : aid_10001111     aid_

The presence, or absence, of prefixes is controlled per API client as part of the Property Manager API. To see how yours is set up, run the Get-PAPIClientSettings command.

  • For usePrefixes set to True, keep the prefix as you use the property commands.
  • For usePrefixes set to False, remove them and only send the value after the underscore (_).

Get-PAPIClientSettings
ruleFormat usePrefixes
---------- -----------
latest            True

Quick reference

Commands here are limited to basic actions most commonly used. Use Get-Command or Get-Help with Property, Properties, Rule, or Include to get a comprehensive list of what's available.

If needed, all commands take parameters for the location and section of your .edgerc authentication file.

Properties

Command Description
Create new property or new property version
New-Property Creates a new property based on a product identifier.
New-PropertyVersion Creates a new version of an existing property.
Get properties, property versions, or property activations
List-Properties
Get-Properties
Gets a list of all your properties.
Get-Property Gets a specific property's details.
Find-Property Finds a property based on given filter.
Get-PropertyVersion Returns details about a specific property version.
List-PropertyActivations Gets a list of all property activations.
Remove property
Remove-Property Removes a property.
Activate or deactivate property
Activate-Property Activates a given property on the staging or production network.
Deactivate-Property Deactivates a given property on the staging or production network.

Rules

Command Description
Get property rule trees, templates, or formats
Get-PropertyRuleTree Gets a given property's rule tree. All rules are in a single JSON file.
Get-PropertyRuleTemplates Get a given property's rule tree. All rules are separated into respective JSON files.
List-RuleFormats Returns a list of available rule formats.
Update property rules
Set-PropertyRuleTree Update a property's rule tree. All rules in a single JSON file.
Set-PropertyRuleTemplates Update a property's rule tree based on the individual JSON files changed.

Includes

Command Description
Create new include or new include version
New-PropertyInclude Creates a new include.
New-PropertyIncludeVersion Creates a new version of an existing include.
Get include or an include's rules, versions, or activations
List-PropertyIncludes
Get-PropertyIncludes
Gets a list of all of your includes.
Get-PropertyIncludeVersion Returns details for a given include.
Get-PropertyIncludeRuleTree Gets an include's rule tree. All rules are in a single JSON file.
Get-PropertyIncludeRuleTemplates Gets an include's rule tree. All rules are separated into respective JSON files.
List-PropertyIncludeActivations Gets a list of all includes activations.
Get-PropertyIncludeActivation Gets a given include's activation status.
Update includes
Set-PropertyIncludeRuleTree Updates an includes rule tree. All rules in a single JSON file.
Set-PropertyIncludeRuleTemplates Update a include's rule tree based on the individual JSON files changed.
Remove includes
Remove-PropertyInclude Removes an include from a property.
Activate or deactivate includes
Activate-PropertyInclude Activates an include on the staging or production network.
Deactivate-PropertyInclude Deactivates an include on the staging or production network.

Product IDs

Product Code
Web Performance Solutions
Dynamic Site Accelerator prd_Site_Accel
Ion Standard prd_Fresca
Ion Premier prd_SPM
Dynamic Site Delivery prd_Site_Del
Rich Media Accelerator prd_Rich_Media_Accel
IoT Edge Connect prd_IoT
Security Solutions
Kona Site Defender prd_Site_Defender
Media Delivery Solutions
Download Delivery prd_Download_Delivery
Object Delivery prd_Object_Delivery
Adaptive Media Delivery prd_Adaptive_Media_Delivery