Guide

Property

New-Property

Suggest Edits

Synopsis

Create or clone a property.

Syntax

New-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>]

New-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>]

New-Property -Body <Object> -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates either a new property from scratch or clones an existing property with its rule tree and optionally its set of assigned hostnames. If creating a new property, you need to specify the product ID, which you can retrieve with the Get-Product operation.

You can create the hostname bucket properties by adding the -UseHostnameBucket switch. If cloning an existing property, you can optionally add the -CloneFromVersionEtag parameter to specify the expected entity tag (ETag) of the source property to ensure it hasn't changed.

Parameters

‑AccountSwitchKey
String Pipeline input: False

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.
‑Body
Conditionally required
Object Parameter sets: body Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑ClonePropertyID
String Parameter sets: attributes-id Pipeline input: False

The ID of the property to clone. If cloning a property, provide this or the -ClonePropertyName.
‑ClonePropertyName
String Parameter sets: attributes-name Pipeline input: False

The name of the property to clone. If cloning a property, provide this or the -ClonePropertyID.
‑ClonePropertyVersion
String Parameter sets: attributes-id, attributes-name Pipeline input: False

The version of the property to clone. Can be an integer or the word latest.
‑ClonePropertyVersionEtag
String Parameter sets: attributes-id, attributes-name Pipeline input: False

Performs an ETag data integrity check on the original property version to ensure no edits have occurred since your last check.
‑ContractID
Required
String Pipeline input: False

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 -GroupID. This parameter is optional except for the create requests.
‑CopyHostnames
Switch Parameter sets: attributes-id, attributes-name Pipeline input: False

Assigns the same set of hostnames to the new property.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Required
String Pipeline input: False

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 -ContractID. This parameter is optional except for the create requests.
‑Name
Conditionally required
String Parameter sets: attributes-id, attributes-name Pipeline input: False

A human-readable name you give to identify your property.
‑ProductID
Conditionally required
String Parameter sets: attributes-id, attributes-name Pipeline input: False

The product's ID.
‑RuleFormat
String Parameter sets: attributes-id, attributes-name Pipeline input: False

The name of the rule format. The rule format can be frozen to a specific version, or represent the latest set of behaviors and criteria. You can retrieve rule formats with Get-RuleFormat.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑UseHostnameBucket
Switch Parameter sets: attributes-id, attributes-name Pipeline input: False

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 6 days ago