BatchServiceClient class

Paquete:

@azure/batch

Extends

BatchServiceClientContext

Constructores

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Inicializa una nueva instancia de la clase BatchServiceClient.

Propiedades

account
application
certificate
computeNode
file
job
jobSchedule
pool
task

Propiedades heredadas

acceptLanguage
apiVersion
batchUrl
credentials
longRunningOperationRetryTimeout	Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

Métodos heredados

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Envíe la solicitud inicial de un LRO (operación de ejecución prolongada) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.
restoreLROPoller(LROPollState)	Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente.
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envíe la solicitud inicial de un LRO (operación de larga duración) y devuelva un LROPoller que proporcione métodos para sondear el LRO y comprobar si el LRO ha finalizado.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envíe el httpRequest proporcionado.

Detalles del constructor

BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)

Inicializa una nueva instancia de la clase BatchServiceClient.

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

Parámetros

credentials

ServiceClientCredentials

Credenciales necesarias para que el cliente se conecte a Azure.

batchUrl

string

Dirección URL base de todas las solicitudes de servicio de Azure Batch.

options

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

Opciones del parámetro

Detalles de las propiedades

account

account: Account

Valor de propiedad

Account

application

application: Application

Valor de propiedad

Application

certificate

certificate: CertificateOperations

Valor de propiedad

CertificateOperations

computeNode

computeNode: ComputeNodeOperations

Valor de propiedad

ComputeNodeOperations

file

file: File

Valor de propiedad

File

job

job: Job

Valor de propiedad

Job

jobSchedule

jobSchedule: JobSchedule

Valor de propiedad

JobSchedule

pool

pool: Pool

Valor de propiedad

Pool

task

task: Task

Valor de propiedad

Task

Detalles de las propiedades heredadas

acceptLanguage

acceptLanguage: string

Valor de propiedad

string

Se hereda deBatchServiceClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor de propiedad

string

heredado deBatchServiceClientContext.apiVersion

batchUrl

batchUrl: string

Valor de propiedad

string

heredado debatchServiceClientContext.batchUrl

credentials

credentials: ServiceClientCredentials

Valor de propiedad

ServiceClientCredentials

heredado debatchServiceClientContext.credentials

longRunningOperationRetryTimeout

Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

longRunningOperationRetryTimeout?: number

Valor de propiedad

number

heredado deBatchServiceClientContext.longRunningOperationRetryTimeout

Detalles de los métodos heredados

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de ejecución prolongada) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.

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

Parámetros

request

WebResource | RequestPrepareOptions

El objeto request

options

RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud

Devoluciones

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

HttpLongRunningOperationResponse que proporciona métodos para interactuar con el LRO.

heredado deBatchServiceClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parámetros

lroPollState

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

Devoluciones

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

heredado deBatchServiceClientContext.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final.

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

Parámetros

request

WebResource | RequestPrepareOptions

El objeto request

options

RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud

Devoluciones

Promise<HttpOperationResponse>

HttpOperationResponse que contiene la solicitud de sondeo final, la respuesta y la respuestaBody.

heredado deBatchServiceClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de larga duración) y devuelva un LROPoller que proporcione métodos para sondear el LRO y comprobar si el LRO ha finalizado.

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

Parámetros

operationArguments

OperationArguments

Argumentos de la operación.

operationSpec

OperationSpec

Especificación de la operación.

options

RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud.

Devoluciones

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

Objeto LROPoller que proporciona métodos para interactuar con el LRO.

heredado deBatchServiceClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

operationArguments

OperationArguments

Argumentos desde los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec

OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

callback

ServiceCallback<any>

Devolución de llamada que se va a llamar cuando se recibe la respuesta.

Devoluciones

Promise<RestResponse>

heredado deBatchServiceClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

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

Parámetros

options

RequestPrepareOptions | WebResourceLike

Devoluciones

Promise<HttpOperationResponse>

heredado debatchServiceClientContext.sendRequest