ListTasksOptionalParams interface

Paket:

@azure/batch

Optionale Parameter.

Extends

OperationOptions

Eigenschaften

clientRequestId	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
expand	Eine OData-$expand-Klausel.
filter	Eine OData-$filter-Klausel. Weitere Informationen zur Konstruktion dieses Filters finden Sie unter https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks.
maxResults	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden.
ocpDate	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.
returnClientRequestId	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
select	Eine OData-$select-Klausel.
timeoutInSeconds	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

clientRequestId

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Eigenschaftswert

string

expand

Eine OData-$expand-Klausel.

expand?: string[]

Eigenschaftswert

string[]

filter

Eine OData-$filter-Klausel. Weitere Informationen zur Konstruktion dieses Filters finden Sie unter https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks.

filter?: string

Eigenschaftswert

string

maxResults

Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden.

maxResults?: number

Eigenschaftswert

number

ocpDate

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

ocpDate?: Date

Eigenschaftswert

Date

returnClientRequestId

Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.

returnClientRequestId?: boolean

Eigenschaftswert

boolean

select

Eine OData-$select-Klausel.

select?: string[]

Eigenschaftswert

string[]

timeoutInSeconds

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

timeoutInSeconds?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

von OperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Von OperationOptions.requestOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von OperationOptions.tracingOptions geerbt