Group

Get-Group

Synopsis

Get or list access control groups.

Syntax

name (Default)

Get-Group [[-GroupName] <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

id

Get-Group [-GroupID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Retrieves a list of all access control groups in a given account or returns a specific group either by its name or ID.

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
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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: id
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupName

Name of the group to retrieve.

Type: String
Parameter Sets: name
Aliases: None
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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