Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageAggregatesListOptionalParams

Package version

interface

An interface representing UsageAggregatesListOptionalParams. Optional Parameters.

extends

RequestOptionsBase

Hierarchy

  • any
    • UsageAggregatesListOptionalParams

Index

Properties

Optional aggregationGranularity

aggregationGranularity: AggregationGranularity
member

{AggregationGranularity} [aggregationGranularity] Daily (default) returns the data in daily granularity, Hourly returns the data in hourly granularity. Possible values include: 'Daily', 'Hourly'. Default value: 'Daily' .

Optional continuationToken

continuationToken: undefined | string
member

{string} [continuationToken] Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in.

Optional showDetails

showDetails: undefined | false | true
member

{boolean} [showDetails] True returns usage data in instance-level detail, false causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime).

Generated using TypeDoc