Reporting group

Set-CPReportingGroup

Synopsis

Update a reporting group.

Syntax

Set-CPReportingGroup [-ReportingGroupID] <Int32> [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Modifies a specific reporting group. You can only modify a reporting group's name and assigned CP codes.

Note: Due to the complexity of the request body, it's recommended that you retrieve the existing reporting group with the Get-CPReportingGroup operation, edit it locally, and pipe the result to this command.

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.

‑Body
Required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑ReportingGroupID
Required

Your reporting group's ID.

‑Section

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

Related Links