BatchClient Class

Definition

A client for an Azure Batch account, used to access the Batch service.

public class BatchClient : IDisposable
type BatchClient = class
    interface IDisposable
Public Class BatchClient
Implements IDisposable
Inheritance
BatchClient
Implements

Properties

ApplicationOperations

Gets an ApplicationOperations for performing application-related operations on the associated account.

CertificateOperations

Gets a CertificateOperations for performing certificate-related operations on the associated account.

CustomBehaviors

Gets or sets a list of behaviors that modify or customize requests to the Batch service.

JobOperations

Gets a JobOperations for performing job-related operations on the associated account.

JobScheduleOperations

Gets a JobScheduleOperations for performing job schedule-related operations on the associated account.

PoolOperations

Gets a PoolOperations for performing pool-related operations on the associated account.

Utilities

Gets a Utilities object containing utility methods for orchestrating multiple Batch operations.

Methods

Close()

Closes the current instance of BatchClient.
Closed instances of BatchClient are unable to make calls to the Batch Service and the behavior and values of any other methods or properties are undefined. These restrictions also apply immediately to any objects that can trace instantation back to this BatchClient. This method is threadsafe and can be called any number of times.

CloseAsync()

Starts an asynchronous operation to close the current instance of BatchClient.
Closed instances of BatchClient are unable to make calls to the Batch Service and the behavior and values of any other methods or properties are undefined. These restrictions also apply immediately to any objects that can trace instantation back to this BatchClient. This method is threadsafe and can be called any number of times.

Dispose()

Calls Close() and releases the unmanaged resources and disposes of the managed resources used by the BatchClient.

Dispose(Boolean)

Releases unmanaged resources used by the BatchClient, and optionally disposes of managed resources.

Open(BatchServiceClient)

Blocking call that creates an instance of BatchClient associated with the specified BatchServiceClient.

Open(BatchSharedKeyCredentials)

Creates an instance of BatchClient.

Open(BatchTokenCredentials)

Creates an instance of BatchClient.

OpenAsync(BatchServiceClient)

Creates an instance of BatchClient associated with the specified BatchServiceClient.

OpenAsync(BatchSharedKeyCredentials)

Creates an instance of BatchClient associated with the specified credentials.

OpenAsync(BatchTokenCredentials)

Creates an instance of BatchClient.

Applies to