BatchRestClient Class

Article
03/10/2016
2 minutes to read

A client for accessing the Azure Batch REST API.

Namespace: Microsoft.Azure.Batch.Protocol
Assembly: Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Inheritance Hierarchy

System.Object
Hyak.Common.ServiceClient<T>
Microsoft.Azure.Batch.Protocol.BatchRestClient

Syntax

public class BatchRestClient : ServiceClient<BatchRestClient>, 
    IBatchRestClient, IDisposable

public ref class BatchRestClient : ServiceClient<BatchRestClient^>, 
    IBatchRestClient, IDisposable

type BatchRestClient = 
    class
        inherit ServiceClient<BatchRestClient>
        interface IBatchRestClient
        interface IDisposable
    end

Public Class BatchRestClient
    Inherits ServiceClient(Of BatchRestClient)
    Implements IBatchRestClient, IDisposable

Constructors

	Name	Description
	BatchRestClient()	Initializes a new instance of the BatchRestClient class.
	BatchRestClient(BatchCredentials)	Initializes a new instance of the BatchRestClient class.
	BatchRestClient(BatchCredentials, HttpClient)	Initializes a new instance of the BatchRestClient class.
	BatchRestClient(BatchCredentials, Uri)	Initializes a new instance of the BatchRestClient class.
	BatchRestClient(BatchCredentials, Uri, HttpClient)	Initializes a new instance of the BatchRestClient class.
	BatchRestClient(HttpClient)	Initializes a new instance of the BatchRestClient class.

Properties

	Name	Description
	Accounts	Operations for managing resources related to this specified account.
	ApiVersion	Gets the API version.
	Applications	Operations for managing applications.
	BaseUri	Gets the URI used as the base for all cloud service requests.
	Certificates	Operations for managing certificates installed onto Azure Batch compute nodes
	ComputeNodes	Contains operations for managing compute nodes in the Batch service.
	Credentials	Gets the credentials for authorizing to the Azure Batch API.
	Files	Contains operations for working with files on Azure Batch compute nodes.
	HttpClient	(Inherited from ServiceClient<T>.)
	HttpMessageHandler	(Inherited from ServiceClient<T>.)
	Jobs	Contains operations for managing Azure Batch jobs.
	JobSchedules	Operations for managing Azure Batch job schedules. A job schedule specifies when to run jobs, and includes a specification that is used to create each job.
	LongRunningOperationInitialTimeout	Gets or sets the initial timeout for Long Running Operations.
	LongRunningOperationRetryTimeout	Gets or sets the retry timeout for Long Running Operations.
	Pools	Contains operations for managing Azure Batch pools.
	Tasks	Contains operations for managing Azure Batch tasks
	UserAgent	(Inherited from ServiceClient<T>.)

Methods

	Name	Description
	AddHandlerToPipeline(DelegatingHandler)	(Inherited from ServiceClient<T>.)
	Clone(ServiceClient<BatchRestClient>)	Clones properties from current instance to another BatchRestClient instance (Overrides ServiceClient<T>.Clone(ServiceClient<T>).)
	Dispose()	(Inherited from ServiceClient<T>.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetHttpPipeline()	(Inherited from ServiceClient<T>.)
	GetType()	(Inherited from Object.)
	InitializeHttpClient(HttpMessageHandler)	(Inherited from ServiceClient<T>.)
	MemberwiseClone()	(Inherited from Object.)
	SetRetryPolicy(RetryPolicy)	(Inherited from ServiceClient<T>.)
	ToString()	(Inherited from Object.)
	WithHandler(DelegatingHandler)	(Inherited from ServiceClient<T>.)
	WithHandler(ServiceClient<T>, DelegatingHandler)	(Inherited from ServiceClient<T>.)
	WithHandlers(IEnumerable<DelegatingHandler>)	(Inherited from ServiceClient<T>.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.