BatchServiceClient class

Pakket:

@azure/batch

Uitbreiding

BatchServiceClientContext

Constructors

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialiseert een nieuw exemplaar van de klasse BatchServiceClient.

Eigenschappen

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Overgenomen eigenschappen

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	De time-out voor opnieuw proberen in seconden voor langdurige bewerkingen. De standaardwaarde is 30.

Overgenomen methoden

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Verzend de eerste aanvraag van een LRO (langdurige bewerking) en haal een HttpLongRunningOperationResponse op die methoden biedt voor het pollen van de LRO en het controleren of de LRO is voltooid.
restoreLROPoller(LROPollState)	Herstel een LROPoller van de opgegeven LROPollState. Deze methode kan worden gebruikt om een LROPoller opnieuw te maken op een ander proces of een andere computer.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Biedt een mechanisme voor het indienen van een aanvraag die een poll uitvoert en het uiteindelijke resultaat opgeeft.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Verzend de eerste aanvraag van een LRO (langdurige bewerking) en haal een LROPoller terug die methoden biedt om de LRO te peilen en te controleren of de LRO is voltooid.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Verzend de opgegeven httpRequest.

Constructordetails

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialiseert een nieuw exemplaar van de klasse BatchServiceClient.

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

Parameters

credentials

ServiceClientCredentials

Referenties die nodig zijn voor de client om verbinding te maken met Azure.

batchUrl

string

De basis-URL voor alle Azure Batch-serviceaanvragen.

options

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

De parameteropties

Eigenschapdetails

account

account: Account

Waarde van eigenschap

Account

application

application: Application

Waarde van eigenschap

Application

certificate

certificate: CertificateOperations

Waarde van eigenschap

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Waarde van eigenschap

ComputeNodeOperations

file

file: File

Waarde van eigenschap

File

job

job: Job

Waarde van eigenschap

Job

jobSchedule

jobSchedule: JobSchedule

Waarde van eigenschap

JobSchedule

pool

pool: Pool

Waarde van eigenschap

Pool

task

task: Task

Waarde van eigenschap

Task

Details van overgenomen eigenschap

acceptLanguage

acceptLanguage: string

Waarde van eigenschap

string

overgenomen vanBatchServiceClientContext.acceptLanguage-

apiVersion

apiVersion?: string

Waarde van eigenschap

string

overgenomen vanBatchServiceClientContext.apiVersion-

batchUrl

batchUrl: string

Waarde van eigenschap

string

overgenomen vanBatchServiceClientContext.batchUrl-

credentials

credentials: ServiceClientCredentials

Waarde van eigenschap

ServiceClientCredentials

overgenomen vanBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

De time-out voor opnieuw proberen in seconden voor langdurige bewerkingen. De standaardwaarde is 30.

longRunningOperationRetryTimeout?: number

Waarde van eigenschap

number

overgenomen vanBatchServiceClientContext.longRunningOperationRetryTimeout

Details overgenomen methode

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Verzend de eerste aanvraag van een LRO (langdurige bewerking) en haal een HttpLongRunningOperationResponse op die methoden biedt voor het pollen van de LRO en het controleren of de LRO is voltooid.

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

Parameters

request

WebResource | RequestPrepareOptions

Het aanvraagobject

options

RequestOptionsBase

Extra opties die moeten worden verzonden tijdens het indienen van de aanvraag

Retouren

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

De HttpLongRunningOperationResponse die methoden biedt voor interactie met de LRO.

overgenomen vanBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Herstel een LROPoller van de opgegeven LROPollState. Deze methode kan worden gebruikt om een LROPoller opnieuw te maken op een ander proces of een andere computer.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameters

lroPollState

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

Retouren

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

overgenomen vanBatchServiceClientContext.restoreLROPoller-

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Biedt een mechanisme voor het indienen van een aanvraag die een poll uitvoert en het uiteindelijke resultaat opgeeft.

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

Parameters

request

WebResource | RequestPrepareOptions

Het aanvraagobject

options

RequestOptionsBase

Extra opties die moeten worden verzonden tijdens het indienen van de aanvraag

Retouren

Promise<HttpOperationResponse>

De HttpOperationResponse met de uiteindelijke pollingaanvraag, het antwoord en de responseBody.

overgenomen vanBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Verzend de eerste aanvraag van een LRO (langdurige bewerking) en haal een LROPoller terug die methoden biedt om de LRO te peilen en te controleren of de LRO is voltooid.

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

Parameters

operationArguments

OperationArguments

De argumenten voor de bewerking.

operationSpec

OperationSpec

De specificatie voor de bewerking.

options

RequestOptionsBase

Extra opties die moeten worden verzonden tijdens het indienen van de aanvraag.

Retouren

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

Het LROPoller-object dat methoden biedt voor interactie met de LRO.

overgenomen vanBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.

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

Parameters

operationArguments

OperationArguments

De argumenten waaruit de sjabloonwaarden van de HTTP-aanvraag worden ingevuld.

operationSpec

OperationSpec

De OperationSpec die moet worden gebruikt om de httpRequest te vullen.

callback

ServiceCallback<any>

De callback die moet worden aangeroepen wanneer het antwoord wordt ontvangen.

Retouren

Promise<RestResponse>

overgenomen vanBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Verzend de opgegeven httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Retouren

Promise<HttpOperationResponse>

overgenomen vanBatchServiceClientContext.sendRequest