Property

New-Property

Synopsis

Create or clone a property.

Syntax

attributes-name (Default)

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're required 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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ClonePropertyID

Specifies the ID of the property to clone. If cloning a property, provide this or ClonePropertyName.

Type: String
Parameter Sets: attributes-id
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClonePropertyName

Specifies the name of the property to clone. If cloning a property, provide this or ClonePropertyID.

Type: String
Parameter Sets: attributes-name
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClonePropertyVersion

Specifies the version of the property to clone. Can be an integer or the word latest.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClonePropertyVersionEtag

Performs an ETag data integrity check on the original property version to ensure no edits have occurred since your last check.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContractID

Unique identifier for the contract. 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 create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CopyHostnames

Assigns the same set of hostnames to the new property.

Type: SwitchParameter
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Unique identifier for the group. 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 create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of your property.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProductID

Unique identifier for the product.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RuleFormat

Name of the rule format. The rule format can be frozen to a specific version, or represent the latest set of behaviors and criteria. Rule formats can be retrieved with Get-RuleFormat.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseHostnameBucket

Create a special type of property where you can add or remove property hostnames without incrementing property versions. Generally used for properties with > 1000 hostnames.

Type: SwitchParameter
Parameter Sets: attributes-name, attributes-id
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs