Share via

BatchAIManagementClient class

  • Reference
Package:
@azure/arm-batchai
Extends
BatchAIManagementClientContext

Constructors

BatchAIManagementClient(ServiceClientCredentials | TokenCredential, string, BatchAIManagementClientOptions)

Initializes a new instance of the BatchAIManagementClient class.

Properties

clusters
experiments
fileServers
jobs
operations
usages
workspaces

Inherited Properties

acceptLanguage
apiVersion
credentials
longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.
subscriptionId

Inherited Methods

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.
restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResource)

Send the provided httpRequest.

Constructor Details

BatchAIManagementClient(ServiceClientCredentials | TokenCredential, string, BatchAIManagementClientOptions)

Initializes a new instance of the BatchAIManagementClient class.

new BatchAIManagementClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: BatchAIManagementClientOptions)

Parameters

credentials

ServiceClientCredentials | TokenCredential

Credentials needed for the client to connect to Azure. Credentials implementing the TokenCredential interface from the @azure/identity package are recommended. For more information about these credentials, see https://www.npmjs.com/package/@azure/identity. Credentials implementing the ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and @azure/ms-rest-browserauth are also supported.

subscriptionId

string

The subscriptionID for the Azure user.

options
BatchAIManagementClientOptions

The parameter options

Property Details

clusters 

clusters: Clusters

Property Value

Clusters

experiments 

experiments: Experiments

Property Value

Experiments

fileServers 

fileServers: FileServers

Property Value

FileServers

jobs 

jobs: Jobs

Property Value

Jobs

operations 

operations: Operations

Property Value

Operations

usages 

usages: Usages

Property Value

Usages

workspaces 

workspaces: Workspaces

Property Value

Workspaces

Inherited Property Details

acceptLanguage 

acceptLanguage: string

Property Value

string

Inherited From BatchAIManagementClientContext.acceptLanguage

apiVersion 

apiVersion?: string

Property Value

string

Inherited From BatchAIManagementClientContext.apiVersion

credentials 

credentials: ServiceClientCredentials | TokenCredential

Property Value

ServiceClientCredentials | TokenCredential

Inherited From BatchAIManagementClientContext.credentials

longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

longRunningOperationRetryTimeout?: number

Property Value

number

Inherited From BatchAIManagementClientContext.longRunningOperationRetryTimeout

subscriptionId 

subscriptionId: string

Property Value

string

Inherited From BatchAIManagementClientContext.subscriptionId

Inherited Method Details

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.

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

Parameters

request

RequestPrepareOptions | WebResource

The request object

options
RequestOptionsBase

Additional options to be sent while making the request

Returns

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

The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.

Inherited From BatchAIManagementClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameters

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

Returns

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

Inherited From BatchAIManagementClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.

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

Parameters

request

RequestPrepareOptions | WebResource

The request object

options
RequestOptionsBase

Additional options to be sent while making the request

Returns

Promise<HttpOperationResponse>

The HttpOperationResponse containing the final polling request, response and the responseBody.

Inherited From BatchAIManagementClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.

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

Parameters

operationArguments
OperationArguments

The arguments to the operation.

operationSpec
OperationSpec

The specification for the operation.

options
RequestOptionsBase

Additional options to be sent while making the request.

Returns

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

The LROPoller object that provides methods for interacting with the LRO.

Inherited From BatchAIManagementClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

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

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

Inherited From BatchAIManagementClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResource)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResource

Returns

Promise<HttpOperationResponse>

Inherited From BatchAIManagementClientContext.sendRequest