Include

Get-PropertyInclude

Synopsis

Get a property include.

Syntax

Get-PropertyInclude -GroupID <String> -ContractId <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PropertyInclude [-IncludeName] <String> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PropertyInclude -IncludeID <String> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all the property includes available under a given contract and group or retrieves a specific property include by its name or ID. When retrieving a single property include, the -GroupID and -ContractID parameters are optional, but mandatory when listing all.

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

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

‑Section

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

Related Links