Commands and help
Get a list of commands or information about a command and its syntax.
Commands
Use Get-Command with a filter from the module level down to a key word within a submodule.
Get-Command *property*
Help
Use Get-Help followed by a command to see its details and syntax. Use a the switch -Full to get parameter descriptions, examples, and links to additional help.
You can also read the help file online in this guide by visiting a submodule's Function index page.
Get-Help New-Property
NAME
New-Property
SYNOPSIS
Creates or clones an existing property configuration.
SYNTAX
New-Property -PropertyName <String> -ProductID
<String> [-RuleFormat <String>]
[-CloneFromVersionEtag <String>] [-CopyHostnames]
[-ClonePropertyID <String>] [-ClonePropertyVersion
<Int32>] [-UseHostnameBucket] -GroupID <String>
-ContractID <String> [-EdgeRCFile <String>] [-Section
<String>] [-AccountSwitchKey <String>]
[<CommonParameters>]
New-Property -Body <Object> -GroupID <String>
-ContractID <String> [-EdgeRCFile <String>] [-Section
<String>] [-AccountSwitchKey <String>]
[<CommonParameters>]
DESCRIPTION
The `New-Property` cmdlet creates a new property with
default settings or clones an existing one, using
another property's rule tree and, optionally, its set
of assigned hostnames.
Creating a new property without passing a set of
rules returns a property with default settings.
Cloning properties lets you design a system of rule
templates targeted to specific domains rather than
maintaing a single set of rules with conditional
logic for your full range of domains.
RELATED LINKS
Common product identifiers: https://techdocs.akamai.co
m/powershell/docs/property-manager#product-ids
Property overview: https://techdocs.akamai.com/powersh
ell/docs/property-manager
Online version: https://techdocs.akamai.com/powershell
/reference/new-property
REMARKS
To see the examples, type: "Get-Help New-Property
-Examples"
For more information, type: "Get-Help New-Property
-Detailed"
For technical information, type: "Get-Help
New-Property -Full"
For online help, type: "Get-Help New-Property -Online"
NAME
New-Property
SYNOPSIS
Creates or clones an existing property configuration.
SYNTAX
New-Property -PropertyName <String> -ProductID
<String> [-RuleFormat <String>]
[-CloneFromVersionEtag <String>] [-CopyHostnames]
[-ClonePropertyID <String>] [-ClonePropertyVersion
<Int32>] [-UseHostnameBucket] -GroupID <String>
-ContractID <String> [-EdgeRCFile <String>] [-Section
<String>] [-AccountSwitchKey <String>]
[<CommonParameters>]
New-Property -Body <Object> -GroupID <String>
-ContractID <String> [-EdgeRCFile <String>] [-Section
<String>] [-AccountSwitchKey <String>]
[<CommonParameters>]
DESCRIPTION
The `New-Property` cmdlet creates a new property with
default settings or clones an existing one, using
another property's rule tree and, optionally, its set
of assigned hostnames.
Creating a new property without passing a set of
rules returns a property with default settings.
Cloning properties lets you design a system of rule
templates targeted to specific domains rather than
maintaing a single set of rules with conditional
logic for your full range of domains.
PARAMETERS
-PropertyName <String>
A human-readable name you give to identify your
property.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProductID <String>
A product ID including the `prd_` prefix.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RuleFormat <String>
A versioned rule schema and set of available
behaviors and criteria. If not provided, we apply
the latest rule format by default.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CloneFromVersionEtag <String>
The `Etag` of the original property version to
clone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CopyHostnames [<SwitchParameter>]
Copies the hostnames as well as rules from the
original property.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ClonePropertyID <String>
ID of the property you would like to clone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClonePropertyVersion <Int32>
Version of the property you would like to clone.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-UseHostnameBucket [<SwitchParameter>]
For users with thousands to tens of thousands of
hostnames, using this switch creates a property
in which rules and hostnames are decoupled so you
can add or remove hostnames without having to
update any of the property's rules or reversion
and reactivate the property.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Body <Object>
The data sent to the endpoint. Value is a
hashtable that includes values for each
parameter.
> Important: Because `Body` is a free field, our
PowerShell module doesn't validate the data you
include, the API does.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-GroupID <String>
Your group ID.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContractID <String>
Your contract ID.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EdgeRCFile <String>
The path to an edgerc file. Defaults to
`~/.edgerc`.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Section <String>
The edgerc section name. Defaults to `default`.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccountSwitchKey <String>
A key used to apply changes to an account
external to your credentials' account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters:
Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction,
WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For
more information, see
about_CommonParameters
(https://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1
--------------------------
PS > New-Property -PropertyName "MyNewPropertyName"
-GroupID "12345" -ContractId "C-0N7RAC7" -ProductID
"prd_Object_Delivery" -ClonePropertyID "12345"
-ClonePropertyVersion 43
Creates a new property by cloning an existing
property at the given version number.
Returned to you is a path to your property resource.
Use this path with the host from your API client as a
fully qualified HATEOAS link to get information about
your new property.
propertyLink
------------
/papi/v1/properties/prp_98765?groupId=grp_12345&contra
ctId=ctr_C-0N7RAC7
-------------------------- EXAMPLE 2
--------------------------
PS > New-Property -PropertyName "MyNewPropertyName"
-GroupID "12345" -ContractId "C-0N7RAC7" -ProductID
"prd_Object_Delivery"
Creates a new property with default settings using
the property name product ID.
Returned to you is a path to your property resource.
Use this path with the host from your API client as a
fully qualified HATEOAS link to get information about
your new property.
propertyLink
------------
/papi/v1/properties/prp_98765?groupId=grp_12345&contra
ctId=ctr_C-0N7RAC7
-------------------------- EXAMPLE 3
--------------------------
PS > New-Property -Body
@{"PropertyName"="MyNewPropertyName";
"ProductID"="prd_Object_Delivery"} -GroupID "12345"
-ContractId "C-0N7RAC7"
Creates a new property with default settings using a
hashtable string to represent your data in the body.
Returned to you is a path to your property resource.
Use this path with the host from your API client as a
fully qualified HATEOAS link to get information about
your new property.
propertyLink
------------
/papi/v1/properties/prp_98765?groupId=grp_12345&contra
ctId=ctr_C-0N7RAC7
RELATED LINKS
Common product identifiers: https://techdocs.akamai.co
m/powershell/docs/property-manager#product-ids
Property overview: https://techdocs.akamai.com/powersh
ell/docs/property-manager
Online version: https://techdocs.akamai.com/powershell
/reference/new-property
Updated 19 days ago