Guide

Report type

Get-ReportType

Suggest Edits

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
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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Name
Conditionally required
String Parameter sets: single Pipeline input: False

The type of report.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑ShowDeprecated
Switch Parameter sets: all Pipeline input: False

When enabled, retrieves deprecated reports.
‑ShowUnavailable
Switch Parameter sets: all Pipeline input: False

When enabled, retrieves unavailable reports.
‑Version
Conditionally required
String Parameter sets: single Pipeline input: False

The version of the report type.

Related Links

User Guide: Reporting

Updated 10 days ago