Report

Get-Report

Synopsis

Get a cacheable report.

Syntax

ids (Default)

Get-Report -Name <String> -Version <String> -Start <String> -End <String> [-ObjectIDs <String>]
 -Interval <String> [-Filters <String>] [-Metrics <String>] [-Limit <String>] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

all

Get-Report -Name <String> -Version <String> -Start <String> -End <String> [-AllObjectIDs] -Interval <String>
 [-Filters <String>] [-Metrics <String>] [-Limit <String>] [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Produces a report in either JSON or CSV format for a specific version of a report type.

While functionally it's identical to the New-Report operation, this operation specifies all request data as query Parameters. It also produces a cacheable result, and therefore, this recursive operation is faster than the New-Report operation.

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

-AllObjectIDs

As an alternative to objectIds, enabling this generates a report that includes all IDs available for the specified object type (each report supports only one specific object type). This parameter is ignored if the request also specifies a set of objectIds.

Type: SwitchParameter
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: False
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

-End

Specifies the end of the reported period as an ISO 8601 date with timezone. Any data that matches the end value's timestamp is excluded from the report.

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

-Filters

Specifies criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name.

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

-Interval

The duration of each data record, either FIVE_MINUTES, HOUR, DAY, WEEK, or MONTH. Support for specific interval values may vary by report type.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: FIVE_MINUTES, HOUR, DAY, WEEK, MONTH

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Limit the number of entries returned. Not supported on all report types.

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

-Metrics

Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report.

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: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ObjectIDs

As an alternative to allObjectIds, specifies the set of unique IDs for the given object type you want to report on, formatted as a comma-delimited list.

Type: String
Parameter Sets: ids
Aliases: None
Required: False
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

-Start

Specifies the start of the reported period as an ISO 8601 date with timezone.

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

-Version

The version of the report type.

Type: String
Parameter Sets: (All)
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