BatchServiceClient class

Paquet:

@azure/batch

Extends

BatchServiceClientContext

Constructeurs

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialise une nouvelle instance de la classe BatchServiceClient.

Propriétés

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Propriétés héritées

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	Délai d’expiration des nouvelles tentatives en secondes pour les opérations de longue durée. La valeur par défaut est 30.

Méthodes héritées

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Envoyez la requête initiale d’un LRO (opération de longue durée) et récupérez un HttpLongRunningOperationResponse qui fournit des méthodes pour interroger le LRO et vérifier si le LRO est terminé.
restoreLROPoller(LROPollState)	Restaurez un LROPoller à partir de l’état LROPollState fourni. Cette méthode peut être utilisée pour recréer un LROPoller sur un autre processus ou machine.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Fournit un mécanisme permettant d’effectuer une demande qui interroge et fournit le résultat final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envoyez la requête initiale d’un LRO (opération longue durée) et récupérez un LROPoller qui fournit des méthodes pour interroger le LRO et vérifier si le LRO est terminé.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envoyez une requête HTTP remplie à l’aide de operationSpec fournie.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envoyez le httpRequest fourni.

Détails du constructeur

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialise une nouvelle instance de la classe BatchServiceClient.

new BatchServiceClient(credentials: ServiceClientCredentials, batchUrl: string, options?: AzureServiceClientOptions)

Paramètres

credentials

ServiceClientCredentials

Informations d’identification nécessaires pour que le client se connecte à Azure.

batchUrl

string

URL de base pour toutes les demandes de service Azure Batch.

options

@azure/ms-rest-azure-js.AzureServiceClientOptions

Options de paramètre

Détails de la propriété

account

account: Account

Valeur de propriété

Account

application

application: Application

Valeur de propriété

Application

certificate

certificate: CertificateOperations

Valeur de propriété

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Valeur de propriété

ComputeNodeOperations

file

file: File

Valeur de propriété

File

job

job: Job

Valeur de propriété

Job

jobSchedule

jobSchedule: JobSchedule

Valeur de propriété

JobSchedule

pool

pool: Pool

Valeur de propriété

Pool

task

task: Task

Valeur de propriété

Task

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

acceptLanguage

acceptLanguage: string

Valeur de propriété

string

héritée deBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valeur de propriété

string

héritée deBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Valeur de propriété

string

héritée deBatchServiceClientContext.batchUrl

credentials

credentials: ServiceClientCredentials

Valeur de propriété

ServiceClientCredentials

héritée deBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

Délai d’expiration des nouvelles tentatives en secondes pour les opérations de longue durée. La valeur par défaut est 30.

longRunningOperationRetryTimeout?: number

Valeur de propriété

number

héritée deBatchServiceClientContext.longRunningOperationRetryTimeout

Détails de la méthode héritée

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Envoyez la requête initiale d’un LRO (opération de longue durée) et récupérez un HttpLongRunningOperationResponse qui fournit des méthodes pour interroger le LRO et vérifier si le LRO est terminé.

function beginLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<LROPoller>

Paramètres

request

WebResource | RequestPrepareOptions

Objet de requête

options

RequestOptionsBase

Options supplémentaires à envoyer lors de la demande

Retours

Promise<@azure/ms-rest-azure-js.LROPoller>

HttpLongRunningOperationResponse qui fournit des méthodes d’interaction avec le LRO.

héritée deBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaurez un LROPoller à partir de l’état LROPollState fourni. Cette méthode peut être utilisée pour recréer un LROPoller sur un autre processus ou machine.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Paramètres

lroPollState

@azure/ms-rest-azure-js.LROPollState

Retours

@azure/ms-rest-azure-js.LROPoller

héritée deBatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Fournit un mécanisme permettant d’effectuer une demande qui interroge et fournit le résultat final.

function sendLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<HttpOperationResponse>

Paramètres

request

WebResource | RequestPrepareOptions

Objet de requête

options

RequestOptionsBase

Options supplémentaires à envoyer lors de la demande

Retours

Promise<HttpOperationResponse>

HttpOperationResponse contenant la demande d’interrogation finale, la réponse et le responseBody.

héritée deBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envoyez la requête initiale d’un LRO (opération longue durée) et récupérez un LROPoller qui fournit des méthodes pour interroger le LRO et vérifier si le LRO est terminé.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

Paramètres

operationArguments

OperationArguments

Arguments de l’opération.

operationSpec

OperationSpec

Spécification de l’opération.

options

RequestOptionsBase

Options supplémentaires à envoyer lors de la demande.

Retours

Promise<@azure/ms-rest-azure-js.LROPoller>

Objet LROPoller qui fournit des méthodes d’interaction avec le LRO.

héritée deBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envoyez une requête HTTP remplie à l’aide de operationSpec fournie.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Paramètres

operationArguments

OperationArguments

Arguments à partir duquel les valeurs de modèle de la requête HTTP seront remplies.

operationSpec

OperationSpec

OperationSpec à utiliser pour remplir le httpRequest.

callback

ServiceCallback<any>

Rappel à appeler lorsque la réponse est reçue.

Retours

Promise<RestResponse>

héritée deBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envoyez le httpRequest fourni.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Paramètres

options

RequestPrepareOptions | WebResourceLike

Retours

Promise<HttpOperationResponse>

héritée deBatchServiceClientContext.sendRequest