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 longa duração. O valor padrão é 30.

Métodos Herdados

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de longa duração) 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 a partir do LROPollState fornecido. Este método pode ser usado para recriar um LROPoller em um processo ou máquina diferente.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Fornece um mecanismo para fazer uma solicitação que irá sondar e fornecer o resultado final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envie o pedido inicial de um LRO (operação de longa duração) e obtenha de volta um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO está concluído.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP que é 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 o cliente se conectar 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 de Propriedade

account

account: Account

Valor de Propriedade

Account

application

application: Application

Valor de Propriedade

Application

certificate

certificate: CertificateOperations

Valor de Propriedade

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Valor de Propriedade

ComputeNodeOperations

file

file: File

Valor de Propriedade

File

job

job: Job

Valor de Propriedade

Job

jobSchedule

jobSchedule: JobSchedule

Valor de Propriedade

JobSchedule

pool

pool: Pool

Valor de Propriedade

Pool

task

task: Task

Valor de Propriedade

Task

Detalhes da Propriedade Herdada

acceptLanguage

acceptLanguage: string

Valor de Propriedade

string

herdado deBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor de Propriedade

string

herdado deBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Valor de Propriedade

string

herdado de BatchServiceClientContext.batchUrl

credentials

credentials: ServiceClientCredentials

Valor de Propriedade

ServiceClientCredentials

herdado deBatchServiceClientContext.credentials

longRunningOperationRetryTimeout

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

longRunningOperationRetryTimeout?: number

Valor de 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 longa duração) 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

Devoluções

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

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

herdado de BatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure um LROPoller a partir do LROPollState fornecido. Este método pode ser usado para recriar um LROPoller em um processo ou máquina diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parâmetros

lroPollState

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

Devoluções

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

herdado de BatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que irá 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

Devoluções

Promise<HttpOperationResponse>

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

herdado de BatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envie o pedido inicial de um LRO (operação de longa duração) e obtenha de volta um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO está 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 para a operação.

options

RequestOptionsBase

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

Devoluções

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

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

herdado de BatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

Parâmetros

operationArguments

OperationArguments

Os argumentos a partir 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 para ligar quando a resposta for recebida.

Devoluções

Promise<RestResponse>

herdado de BatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

options

RequestPrepareOptions | WebResourceLike

Devoluções

Promise<HttpOperationResponse>

herdado de BatchServiceClientContext.sendRequest