Guide

Property

Get-Property

Suggest Edits

Synopsis

Get a property.

Syntax

Get-Property -GroupID <String> -ContractId <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-Property [-PropertyName] <String> [-GroupID <String>] [-ContractId <Object>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-Property -PropertyID <String> [-GroupID <String>] [-ContractId <Object>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

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

Parameters

‑AccountSwitchKey
String Pipeline 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
Conditionally required
Object Parameter sets: all, single-id, single-name Pipeline input: ByPropertyName

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
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Conditionally required
String Parameter sets: all, single-id, single-name Pipeline input: ByPropertyName

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.
‑PropertyID
Conditionally required
String Parameter sets: single-id Pipeline input: False

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑PropertyName
Conditionally required
String Parameter sets: single-name Pipeline input: False

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑Section
String Pipeline input: False

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

Related Links

Updated 8 days ago