DeleteTaskFileOptionalParams interface

Пакет:

@azure/batch

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

Extends

OperationOptions

Свойства

clientRequestId	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
ocpDate	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.
recursive	Следует ли удалять дочерние элементы каталога. Если параметр filePath представляет каталог вместо файла, можно задать рекурсивное значение true для удаления каталога и всех файлов и подкаталогов в нем. Если рекурсив имеет значение false, каталог должен быть пустым, или удаление завершится ошибкой.
returnClientRequestId	Должен ли сервер возвращать идентификатор client-request-id в ответе.
timeoutInSeconds	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

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

abortSignal	Сигнал, который можно использовать для прерывания запросов.
onResponse	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
requestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
tracingOptions	Параметры, используемые при включении трассировки.

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

clientRequestId

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

clientRequestId?: string

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

string

ocpDate

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

ocpDate?: Date

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

Date

recursive

Следует ли удалять дочерние элементы каталога. Если параметр filePath представляет каталог вместо файла, можно задать рекурсивное значение true для удаления каталога и всех файлов и подкаталогов в нем. Если рекурсив имеет значение false, каталог должен быть пустым, или удаление завершится ошибкой.

recursive?: boolean

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

boolean

returnClientRequestId

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

returnClientRequestId?: boolean

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

boolean

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