BatchServiceClient class

Paket:

@azure/batch

Extends

BatchServiceClientContext

Konstruktorer

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initierar en ny instans av klassen BatchServiceClient.

Egenskaper

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Ärvda egenskaper

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	Tidsgränsen för återförsök i sekunder för tidskrävande åtgärder. Standardvärdet är 30.

Ärvda metoder

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en HttpLongRunningOperationResponse som innehåller metoder för att avsöka LRO och kontrollera om LRO är klar.
restoreLROPoller(LROPollState)	Återställ en LROPoller från den angivna LROPollState. Den här metoden kan användas för att återskapa en LROPoller på en annan process eller dator.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Tillhandahåller en mekanism för att göra en begäran som ska avsöka och tillhandahålla slutresultatet.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en LROPoller som tillhandahåller metoder för att avsöka LRO och kontrollera om LRO är klar.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Skicka angivet httpRequest.

Konstruktorinformation

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initierar en ny instans av klassen BatchServiceClient.

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

Parametrar

credentials

ServiceClientCredentials

Autentiseringsuppgifter som krävs för att klienten ska kunna ansluta till Azure.

batchUrl

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.

options

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

Parameteralternativen

Egenskapsinformation

account

account: Account

Egenskapsvärde

Account

application

application: Application

Egenskapsvärde

Application

certificate

certificate: CertificateOperations

Egenskapsvärde

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Egenskapsvärde

ComputeNodeOperations

file

file: File

Egenskapsvärde

File

job

job: Job

Egenskapsvärde

Job

jobSchedule

jobSchedule: JobSchedule

Egenskapsvärde

JobSchedule

pool

pool: Pool

Egenskapsvärde

Pool

task

task: Task

Egenskapsvärde

Task

Information om ärvda egenskaper

acceptLanguage

acceptLanguage: string

Egenskapsvärde

string

ärvs frånBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Egenskapsvärde

string

ärvs frånBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Egenskapsvärde

string

ärvd frånBatchServiceClientContext.batchUrl

credentials

credentials: ServiceClientCredentials

Egenskapsvärde

ServiceClientCredentials

ärvd frånBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

Tidsgränsen för återförsök i sekunder för tidskrävande åtgärder. Standardvärdet är 30.

longRunningOperationRetryTimeout?: number

Egenskapsvärde

number

ärvd frånBatchServiceClientContext.longRunningOperationRetryTimeout

Ärvd metodinformation

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en HttpLongRunningOperationResponse som innehåller metoder för att avsöka LRO och kontrollera om LRO är klar.

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

Parametrar

request

WebResource | RequestPrepareOptions

Begärandeobjektet

options

RequestOptionsBase

Ytterligare alternativ som ska skickas när begäran skickas

Returer

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

HttpLongRunningOperationResponse som tillhandahåller metoder för att interagera med LRO.

ärvd frånBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Återställ en LROPoller från den angivna LROPollState. Den här metoden kan användas för att återskapa en LROPoller på en annan process eller dator.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parametrar

lroPollState

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

Returer

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

ärvd frånBatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Tillhandahåller en mekanism för att göra en begäran som ska avsöka och tillhandahålla slutresultatet.

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

Parametrar

request

WebResource | RequestPrepareOptions

Begärandeobjektet

options

RequestOptionsBase

Ytterligare alternativ som ska skickas när begäran skickas

Returer

Promise<HttpOperationResponse>

HttpOperationResponse som innehåller den slutliga avsökningsbegäran, svaret och responseBody.

ärvd frånBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en LROPoller som tillhandahåller metoder för att avsöka LRO och kontrollera om LRO är klar.

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

Parametrar

operationArguments

OperationArguments

Argumenten för åtgärden.

operationSpec

OperationSpec

Specifikationen för åtgärden.

options

RequestOptionsBase

Ytterligare alternativ som ska skickas när begäran skickas.

Returer

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

LROPoller-objektet som innehåller metoder för att interagera med LRO.

ärvd frånBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.

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

Parametrar

operationArguments

OperationArguments

Argumenten som HTTP-begärans mallade värden fylls i från.

operationSpec

OperationSpec

Den OperationSpec som ska användas för att fylla i httpRequest.

callback

ServiceCallback<any>

Återanropet för att anropa när svaret tas emot.

Returer

Promise<RestResponse>

ärvd frånBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Skicka angivet httpRequest.

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

Parametrar

options

RequestPrepareOptions | WebResourceLike

Returer

Promise<HttpOperationResponse>

ärvd frånBatchServiceClientContext.sendRequest