ListNodesOptionalParams interface

Пакет:
@azure/batch

Необязательные параметры.

Extends
OperationOptions

Свойства

clientRequestId

Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
filter

Предложение OData $filter. Для получения дополнительной информации о построении этого фильтра см. https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
maxResults

Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
ocpDate

Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.
returnClientRequestId

Должен ли сервер возвращать идентификатор client-request-id в ответе.
select

Предложение OData $select.
timeoutInSeconds

Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
tracingOptions

Параметры, используемые при включении трассировки.

Сведения о свойстве

clientRequestId

Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Значение свойства

string

filter

Предложение OData $filter. Для получения дополнительной информации о построении этого фильтра см. https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

filter?: string

Значение свойства

string

maxResults

Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.

maxResults?: number

Значение свойства

number

ocpDate

Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

ocpDate?: Date

Значение свойства

Date

returnClientRequestId

Должен ли сервер возвращать идентификатор client-request-id в ответе.

returnClientRequestId?: boolean

Значение свойства

boolean

select

Предложение OData $select.

select?: string[]

Значение свойства

string[]

timeoutInSeconds

Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

timeoutInSeconds?: number

Значение свойства

number

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

наследуется от OperationOptions.abortSignal

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

RawResponseCallback

наследуется от OperationOptions.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

OperationRequestOptions

наследуется от OperationOptions.requestOptions

tracingOptions

Параметры, используемые при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

наследуется от OperationOptions.tracingOptions