BatchServiceClient class

Pacote:

@azure/batch

Extends

BatchServiceClientContext

Construtores

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Inicializa uma nova instância da classe BatchServiceClient.

Propriedades

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Propriedades herdadas

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	O tempo limite de repetição em segundos para operações de execução longa. O valor padrão é 30.

Métodos herdados

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de execução prolongada) e obtenha de volta um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.
restoreLROPoller(LROPollState)	Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envie o httpRequest fornecido.

Detalhes do construtor

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Inicializa uma nova instância da classe BatchServiceClient.

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

Parâmetros

credentials

ServiceClientCredentials

Credenciais necessárias para que o cliente se conecte ao Azure.

batchUrl

string

A URL base para todas as solicitações de serviço do Lote do Azure.

options

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

As opções de parâmetro

Detalhes da propriedade

account

account: Account

Valor da propriedade

Account

application

application: Application

Valor da propriedade

Application

certificate

certificate: CertificateOperations

Valor da propriedade

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Valor da propriedade

ComputeNodeOperations

file

file: File

Valor da propriedade

File

job

job: Job

Valor da propriedade

Job

jobSchedule

jobSchedule: JobSchedule

Valor da propriedade

JobSchedule

pool

pool: Pool

Valor da propriedade

Pool

task

task: Task

Valor da propriedade

Task

Detalhes das propriedades herdadas

acceptLanguage

acceptLanguage: string

Valor da propriedade

string

herdado deBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor da propriedade

string

herdado deBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Valor da propriedade

string

herdado deBatchServiceClientContext.batchUrl

credentials

credentials: ServiceClientCredentials

Valor da propriedade

ServiceClientCredentials

herdado deBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

O tempo limite de repetição em segundos para operações de execução longa. O valor padrão é 30.

longRunningOperationRetryTimeout?: number

Valor da propriedade

number

herdado deBatchServiceClientContext.longRunningOperationRetryTimeout

Detalhes do método herdado

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e obtenha de volta um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

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

Parâmetros

request

WebResource | RequestPrepareOptions

O objeto de solicitação

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

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

O HttpLongRunningOperationResponse que fornece métodos para interagir com o LRO.

herdado deBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parâmetros

lroPollState

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

Retornos

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

herdado deBatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.

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

Parâmetros

request

WebResource | RequestPrepareOptions

O objeto de solicitação

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

Promise<HttpOperationResponse>

O HttpOperationResponse que contém a solicitação de sondagem final, a resposta e o responseBody.

herdado deBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

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

Parâmetros

operationArguments

OperationArguments

Os argumentos para a operação.

operationSpec

OperationSpec

A especificação da operação.

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação.

Retornos

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

O objeto LROPoller que fornece métodos para interagir com o LRO.

herdado deBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments

OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec

OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

callback

ServiceCallback<any>

O retorno de chamada a ser chamado quando a resposta é recebida.

Retornos

Promise<RestResponse>

herdado deBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

options

RequestPrepareOptions | WebResourceLike

Retornos

Promise<HttpOperationResponse>

herdado deBatchServiceClientContext.sendRequest