ListPoolsOptionalParams interface

Package:

@azure/batch

Optional parameters.

Extends

OperationOptions

Properties

clientRequestId	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.
expand	An OData $expand clause.
filter	An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.
maxResults	The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
ocpDate	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	Whether the server should return the client-request-id in the response.
select	An OData $select clause.
timeoutInSeconds	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.".

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Property Details

clientRequestId

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.

clientRequestId?: string

Property Value

string

expand

An OData $expand clause.

expand?: string[]

Property Value

string[]

filter

An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.

filter?: string

Property Value

string

maxResults

The maximum number of items to return in the response. A maximum of 1000 applications can be returned.

maxResults?: number

Property Value

number

ocpDate

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.

ocpDate?: Date

Property Value

Date

returnClientRequestId

Whether the server should return the client-request-id in the response.

returnClientRequestId?: boolean

Property Value

boolean

select

An OData $select clause.

select?: string[]

Property Value

string[]

timeoutInSeconds

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.".

timeoutInSeconds?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions