Property
Get-Property
Synopsis
Get a property.
Syntax
all (Default)
Get-Property -GroupID <String> -ContractId <String> [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
single-name
Get-Property [-PropertyName] <String> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>]
[-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
single-id
Get-Property -PropertyID <String> [-GroupID <String>] [-ContractId <String>] [-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
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position Named
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-ContractId
Unique identifier for the contract. 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 create requests.
Type String
Parameter Sets all
Aliases contractIds
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position Named
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-GroupID
Unique identifier for the group. 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 create requests.
Type String
Parameter Sets all
Aliases None
RequiredTrue
Position Named
Default value None
Accept pipeline input True (ByPropertyName)
Accept wildcard charactersFalse
Type String
Parameter Sets single-name, single-id
Aliases None
RequiredFalse
Position Named
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-PropertyID
Unique identifier for the property. Commonly you only need to specify one of: PropertyName
, PropertyID
.
Type String
Parameter Sets single-id
Aliases None
RequiredTrue
Position Named
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-PropertyName
Name of your property. Commonly you only need to specify one of: PropertyName
, PropertyID
.
Type String
Parameter Sets single-name
Aliases None
RequiredTrue
Position0
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position Named
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
CommonParameters
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable
. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Related links
Updated about 1 month ago