TaskListOptions interface

Paquet:

@azure/batch

Paramètres supplémentaires pour l’opération de liste.

Propriétés

clientRequestId	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
expand	Clause $expand OData.
filter	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.
maxResults	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 tâches peut être retourné. Valeur par défaut : 1 000.
ocpDate	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.
returnClientRequestId	Indique si le serveur doit retourner l’ID client-request-id dans la réponse. Valeur par défaut : false.
select	Clause OData $select.
timeout	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Valeur par défaut : 30.

Détails de la propriété

clientRequestId

L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Valeur de propriété

string

expand

Clause $expand OData.

expand?: string

Valeur de propriété

string

filter

Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

filter?: string

Valeur de propriété

string

maxResults

Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 tâches peut être retourné. Valeur par défaut : 1 000.

maxResults?: number

Valeur de propriété

number

ocpDate

Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

ocpDate?: Date

Valeur de propriété

Date

returnClientRequestId

Indique si le serveur doit retourner l’ID client-request-id dans la réponse. Valeur par défaut : false.

returnClientRequestId?: boolean

Valeur de propriété

boolean

select

Clause OData $select.

select?: string

Valeur de propriété

string

timeout

Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Valeur par défaut : 30.

timeout?: number

Valeur de propriété

number