ListPoolsOptionalParams interface

Paquete:
@azure/batch

Parámetros opcionales.

Extends
OperationOptions

Propiedades

clientRequestId

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
expand

Una cláusula $expand OData.
filter

Una cláusula $filter de OData. Para más información sobre cómo construir este filtro, véase https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.
maxResults

Número máximo de elementos que se van a devolver en la respuesta. Se pueden devolver un máximo de 1000 solicitudes.
ocpDate

Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.
returnClientRequestId

Si el servidor debe devolver el client-request-id en la respuesta.
select

Una cláusula $select de OData.
timeoutInSeconds

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.
onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
tracingOptions

Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

clientRequestId

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Valor de propiedad

string

expand

Una cláusula $expand OData.

expand?: string[]

Valor de propiedad

string[]

filter

Una cláusula $filter de OData. Para más información sobre cómo construir este filtro, véase https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.

filter?: string

Valor de propiedad

string

maxResults

Número máximo de elementos que se van a devolver en la respuesta. Se pueden devolver un máximo de 1000 solicitudes.

maxResults?: number

Valor de propiedad

number

ocpDate

Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

ocpDate?: Date

Valor de propiedad

Date

returnClientRequestId

Si el servidor debe devolver el client-request-id en la respuesta.

returnClientRequestId?: boolean

Valor de propiedad

boolean

select

Una cláusula $select de OData.

select?: string[]

Valor de propiedad

string[]

timeoutInSeconds

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

timeoutInSeconds?: number

Valor de propiedad

number

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

heredado de OperationOptions.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

heredado de OperationOptions.onResponse

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

heredado de OperationOptions.tracingOptions