Include

New-PropertyInclude

Synopsis

Create or clone a property include.

Syntax

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>]
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>]
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, version 1 is created automatically.

Parameters

‑AccountSwitchKey

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

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

‑CloneIncludeID

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

‑CloneIncludeName

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

‑CloneIncludeVersion

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

‑CloneIncludeVersionEtag

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

‑ContractID
Required

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.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID
Required

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.

‑IncludeType
Conditionally required

The type of an include. Used for filtering. One of:

- 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, often managed by a central team.

‑Name
Conditionally required

A human-readable name you give to identify your property.

‑ProductID
Conditionally required

The product's ID.

‑RuleFormat

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

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links