PoolListUsageMetricsOptions Class

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

PoolListUsageMetricsOptions.cs

Additional parameters for ListUsageMetrics operation.

public class PoolListUsageMetricsOptions : Microsoft.Azure.Batch.Protocol.Models.IODataFilter, Microsoft.Azure.Batch.Protocol.Models.ITimeoutOptions

type PoolListUsageMetricsOptions = class
    interface ITimeoutOptions
    interface IOptions
    interface IODataFilter

Public Class PoolListUsageMetricsOptions
Implements IODataFilter, ITimeoutOptions

Inheritance

Object

PoolListUsageMetricsOptions

Implements

IODataFilter IOptions ITimeoutOptions

Constructors

PoolListUsageMetricsOptions()	Initializes a new instance of the PoolListUsageMetricsOptions class.
PoolListUsageMetricsOptions(Nullable<DateTime>, Nullable<DateTime>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>)	Initializes a new instance of the PoolListUsageMetricsOptions class.

Properties

ClientRequestId	Gets or sets 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.
EndTime	Gets or sets 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.
Filter	Gets or sets an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
MaxResults	Gets or sets the maximum number of items to return in the response. A maximum of 1000 results will be returned.
OcpDate	Gets or sets 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.
ReturnClientRequestId	Gets or sets whether the server should return the client-request-id in the response.
StartTime	Gets or sets 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.
Timeout	Gets or sets the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.