Report type

Get-ReportType

Synopsis

Get or list report types.

Syntax

Get-ReportType [-ShowDeprecated] [-ShowUnavailable] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-ReportType -Name <String> -Version <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all report types or retrieves a specific version of a report type.

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.

‑Name
Conditionally required

The type of report.

‑Section

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

‑ShowDeprecated

When enabled, retrieves deprecated reports.

‑ShowUnavailable

When enabled, retrieves unavailable reports.

‑Version
Conditionally required

The version of the report type.

Related Links

User Guide: Reporting