Include

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`	StringPipeline 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.
`‑ContractId`	StringPipeline 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.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑GroupID`	StringPipeline 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.
`‑IncludeActivationID` Required	StringPipeline input: False The ID of your property or include activation.
`‑Limit`	IntPipeline input: False For paginated responses, the number of `hostnames` objects to include on each page.
`‑Offset`	IntPipeline input: False For paginated responses, the page of results you want to navigate to, starting from `0`.
`‑PropertyID` Conditionally required	StringParameter sets: `id`Pipeline input: False Your property's ID. Commonly, you only need to specify either `-PropertyName` or `-PropertyID`.
`‑PropertyName` Conditionally required	StringParameter sets: `name`Pipeline input: False A human-readable name for your property. Commonly, you only need to specify either `-PropertyName` or `-PropertyID`.
`‑PropertyVersion` Required	StringPipeline input: False Property's incremental version number. Can be an integer or the word `latest`.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.

Related Links

Updated 3 months ago