Guide

Reporting group

Get-CPReportingGroup

Suggest Edits

Synopsis

Get a reporting group.

Syntax

Get-CPReportingGroup [-ContractID <String>] [-GroupID <String>] [-Name <String>] [-CPCodeID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-CPReportingGroup [-ReportingGroupID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all CP reporting groups or returns a specific CP reporting group by its ID.

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.
‑CPCodeID
String Parameter sets: all Pipeline input: False

Your CP code's ID.
‑ContractID
String Parameter sets: all Pipeline input: False

The ID of the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
String Parameter sets: all Pipeline input: False

The ID of the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only.
‑Name
String Parameter sets: all Pipeline input: False

The name of the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code name only.
‑ReportingGroupID
Int Parameter sets: single Pipeline input: False

Your reporting group's ID.
‑Section
String Pipeline input: False

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

Related Links

Updated about 1 month ago