ListPoolsOptionalParams interface

Paquet:

@azure/batch

Paramètres facultatifs.

Extends

OperationOptions

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, voir https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.
maxresults	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1000 candidatures peuvent être retournées.
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.
select	Clause OData $select.
timeOutInSeconds	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. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. »

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
tracingOptions	Options utilisées lorsque le suivi est activé.

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, voir https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.

filter?: string

Valeur de propriété

string

maxresults

Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1000 candidatures peuvent être retournées.

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.

returnClientRequestId?: boolean

Valeur de propriété

boolean

select

Clause OData $select.

select?: string[]

Valeur de propriété

string[]

timeOutInSeconds

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. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. »

timeOutInSeconds?: number

Valeur de propriété

number

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité de OperationOptions.requestOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de OperationOptions.tracingOptions