BatchServiceClient class

Paket:

@azure/batch

Extends

BatchServiceClientContext

Konstruktoren

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialisiert eine neue Instanz der BatchServiceClient-Klasse.

Eigenschaften

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Geerbte Eigenschaften

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	Das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung. Der Standardwert ist 30.

Geerbte Methoden

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen HttpLongRunningOperationResponse zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.
restoreLROPoller(LROPollState)	Stellen Sie einen LROPoller aus dem bereitgestellten LROPollState wieder her. Diese Methode kann verwendet werden, um einen LROPoller auf einem anderen Prozess oder computer neu zu erstellen.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Stellt einen Mechanismus bereit, um eine Anforderung zu stellen, die das endgültige Ergebnis abruft und bereitstellt.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen LROPoller zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.
sendRequest(RequestPrepareOptions | WebResourceLike)	Senden Sie die bereitgestellte httpRequest.

Details zum Konstruktor

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Initialisiert eine neue Instanz der BatchServiceClient-Klasse.

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

Parameter

credentials

ServiceClientCredentials

Anmeldeinformationen, die für den Client erforderlich sind, um eine Verbindung mit Azure herzustellen.

batchUrl

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.

options

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

Die Parameteroptionen

Details zur Eigenschaft

account

account: Account

Eigenschaftswert

Account

application

application: Application

Eigenschaftswert

Application

certificate

certificate: CertificateOperations

Eigenschaftswert

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Eigenschaftswert

ComputeNodeOperations

file

file: File

Eigenschaftswert

File

job

job: Job

Eigenschaftswert

Job

jobSchedule

jobSchedule: JobSchedule

Eigenschaftswert

JobSchedule

pool

pool: Pool

Eigenschaftswert

Pool

task

task: Task

Eigenschaftswert

Task

Geerbte Eigenschaftsdetails

acceptLanguage

acceptLanguage: string

Eigenschaftswert

string

geerbt vonBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Eigenschaftswert

string

geerbt vonBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Eigenschaftswert

string

geerbt vonBatchServiceClientContext.batchUrl-

credentials

credentials: ServiceClientCredentials

Eigenschaftswert

ServiceClientCredentials

geerbt vonBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

Das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung. Der Standardwert ist 30.

longRunningOperationRetryTimeout?: number

Eigenschaftswert

number

geerbt vonBatchServiceClientContext.longRunningOperationRetryTimeout-

Details zur geerbten Methode

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen HttpLongRunningOperationResponse zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

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

Parameter

request

WebResource | RequestPrepareOptions

Das Anforderungsobjekt

options

RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen

Gibt zurück

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

HttpLongRunningOperationResponse, das Methoden für die Interaktion mit dem LRO bereitstellt.

geerbt vonBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Stellen Sie einen LROPoller aus dem bereitgestellten LROPollState wieder her. Diese Methode kann verwendet werden, um einen LROPoller auf einem anderen Prozess oder computer neu zu erstellen.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameter

lroPollState

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

Gibt zurück

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

geerbt vonBatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Stellt einen Mechanismus bereit, um eine Anforderung zu stellen, die das endgültige Ergebnis abruft und bereitstellt.

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

Parameter

request

WebResource | RequestPrepareOptions

Das Anforderungsobjekt

options

RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen

Gibt zurück

Promise<HttpOperationResponse>

Die HttpOperationResponse, die die endgültige Abfrageanforderung, Antwort und den responseBody enthält.

geerbt vonBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen LROPoller zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

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

Parameter

operationArguments

OperationArguments

Die Argumente für den Vorgang.

operationSpec

OperationSpec

Die Spezifikation für den Vorgang.

options

RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen.

Gibt zurück

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

Das LROPoller-Objekt, das Methoden für die Interaktion mit dem LRO bereitstellt.

geerbt vonBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.

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

Parameter

operationArguments

OperationArguments

Die Argumente, aus denen die vorlagenbasierten Werte der HTTP-Anforderung ausgefüllt werden.

operationSpec

OperationSpec

Die OperationSpec, die zum Auffüllen der httpRequest verwendet werden soll.

callback

ServiceCallback<any>

Der Rückruf, der aufgerufen werden soll, wenn die Antwort empfangen wird.

Gibt zurück

Promise<RestResponse>

geerbt vonBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

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

Parameter

options

RequestPrepareOptions | WebResourceLike

Gibt zurück

Promise<HttpOperationResponse>

geerbt vonBatchServiceClientContext.sendRequest