Include

Test-PropertyInclude

Synopsis

Validate an include.

Syntax

Test-PropertyInclude [-PropertyName] <String> [-PropertyVersion] <String> [-IncludeActivationID] <String> [-Offset <Int32>] [-Limit <Int32>] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Test-PropertyInclude -PropertyID <String> [-PropertyVersion] <String> [-IncludeActivationID] <String> [-Offset <Int32>] [-Limit <Int32>] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets the results of an include validation against the specified parent property version that references the include.

Note: The required -IncludeActivationID is only available as the response to an activation request, and not when listing Include activations.

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.

‑ContractId

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

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.

‑IncludeActivationID
Required

The ID of your property or include activation.

‑Limit

For paginated responses, the number of hostnames objects to include on each page.

‑Offset

For paginated responses, the page of results you want to navigate to, starting from 0.

‑PropertyID
Conditionally required

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyName
Conditionally required

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyVersion
Required

Property's incremental version number. Can be an integer or the word latest.

‑Section

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

Related Links