Report

Synopsis

Get report options.

Syntax

Get-Report [-Report] <String> [-ProductFamily] <String> [-ReportingArea] <String> [-QueryID] <String> [[-AccountSwitchKey] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Returns available options to generate a single report, or retrieve available reports by Product Family and Reporting Area.

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.

‑EdgeRCFile

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

‑ProductFamily
Required

The area of products.

‑QueryID
Required

Unique identifier of the previous asynchronous request to fetch report data.

‑Report
Required

An individual report name.

‑ReportingArea
Required

The grouping of reports related to the same area.

‑Section

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

Related Links