Include

New-PropertyInclude

Synopsis

Create or clone a property include.

Syntax

attributes-name (Default)

New-PropertyInclude -Name <String> -ProductID <String> [-RuleFormat <String>] -IncludeType <String>
 [-CloneIncludeName <String>] [-CloneIncludeVersion <String>] [-CloneIncludeVersionEtag <String>]
 -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

attributes-id

New-PropertyInclude -Name <String> -ProductID <String> [-RuleFormat <String>] -IncludeType <String>
 [-CloneIncludeID <String>] [-CloneIncludeVersion <String>] [-CloneIncludeVersionEtag <String>]
 -GroupID <String> -ContractID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

body

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

Description

Creates either a new include from scratch or clones an existing include with its rule tree. When creating a new include, its version 1 is created automatically.

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

-CloneIncludeID

Specifies the ID of the property include to clone. If cloning an include, provide this or CloneIncludeName.

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

-CloneIncludeName

Specifies the name of the property include to clone. If cloning an include, provide this or CloneIncludeID.

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

-CloneIncludeVersion

Specifies the version of the property include 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

-CloneIncludeVersionEtag

Performs an ETag data integrity check on the original property include 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

-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

-IncludeType

The type of an include.

MICROSERVICES specifies includes with a separate access control and activation flow, which allows different teams to work independently on different parts of a single site. In a parent property's rule tree, you add the MICROSERVICES includes to rules with mutually exclusive path matches.
COMMON_SETTINGS specifies includes used across different properties that share a significant number of settings.

Type: String
Parameter Sets: attributes-name, attributes-id
Aliases:
Accepted values: MICROSERVICES, COMMON_SETTINGS

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

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