Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PoolListUsageMetricsOptions

Package version

Additional parameters for listUsageMetrics operation.

Hierarchy

  • PoolListUsageMetricsOptions

Index

Properties

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional endTime

endTime: Date

The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 results will be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional startTime

startTime: Date

The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

Generated using TypeDoc