Include parent

Synopsis

List parent properties.

Syntax

Get-PropertyIncludeParent [-IncludeName] <String> [-Offset <Int32>] [-Limit <Int32>] [-ContractID <String>] [-GroupID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PropertyIncludeParent -IncludeID <String> [-Offset <Int32>] [-Limit <Int32>] [-ContractID <String>] [-GroupID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Lists all active properties that reference a specific include. Combine optional query parameters to paginate, sort, and filter the results.

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.

‑IncludeID
Conditionally required

Your include's ID. Commonly, you only need to specify either -IncludeName or -IncludeID.

‑IncludeName
Conditionally required

A human-readable name of your property include.

‑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.

‑Section

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

Related Links