Report type

Get-ReportType

Synopsis

Get or list report types.

Syntax

all (Default)

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

single

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Identifies the type of report.

Type: String
Parameter Sets: single
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowDeprecated

Specifies if deprecated reports should be shown.

Type: SwitchParameter
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowUnavailable

Specifies if unavailable reports should be shown.

Type: SwitchParameter
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Version

The version of the report type.

Type: String
Parameter Sets: single
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object