BatchServiceClient Class

Definition

A client for issuing REST requests to the Azure Batch service.

public class BatchServiceClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.Batch.Protocol.BatchServiceClient>, IDisposable, Microsoft.Azure.Batch.Protocol.IBatchServiceClient, Microsoft.Rest.Azure.IAzureClient
type BatchServiceClient = class
    inherit ServiceClient<BatchServiceClient>
    interface IBatchServiceClient
    interface IDisposable
    interface IAzureClient
Public Class BatchServiceClient
Inherits ServiceClient(Of BatchServiceClient)
Implements IAzureClient, IBatchServiceClient, IDisposable
Inheritance
Implements

Constructors

BatchServiceClient(DelegatingHandler[])

Initializes a new instance of the BatchServiceClient class.

BatchServiceClient(HttpClient, Boolean)

Initializes a new instance of the BatchServiceClient class.

BatchServiceClient(HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the BatchServiceClient class.

BatchServiceClient(ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the BatchServiceClient class.

BatchServiceClient(ServiceClientCredentials, HttpClient, Boolean)

Initializes a new instance of the BatchServiceClient class.

BatchServiceClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the BatchServiceClient class.

Properties

AcceptLanguage

The preferred language for the response.

Account

Gets the IAccountOperations.

ApiVersion

Client API Version.

Application

Gets the IApplicationOperations.

BatchUrl

The base URL for all Azure Batch service requests.

Certificate

Gets the ICertificateOperations.

ComputeNode

Gets the IComputeNodeOperations.

ComputeNodeExtension

Gets the IComputeNodeExtensionOperations.

Credentials

Credentials needed for the client to connect to Azure.

DeserializationSettings

Gets or sets json deserialization settings.

File

Gets the IFileOperations.

FirstMessageHandler (Inherited from ServiceClient<T>)
GenerateClientRequestId

Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

HttpClient (Inherited from ServiceClient<T>)
HttpClientHandler (Inherited from ServiceClient<T>)
HttpMessageHandlers (Inherited from ServiceClient<T>)
Job

Gets the IJobOperations.

JobSchedule

Gets the IJobScheduleOperations.

LongRunningOperationRetryTimeout

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

Pool

Gets the IPoolOperations.

SerializationSettings

Gets or sets json serialization settings.

Task

Gets the ITaskOperations.

UserAgent (Inherited from ServiceClient<T>)

Methods

CreateHttpHandlerPipeline(HttpClientHandler, DelegatingHandler[]) (Inherited from ServiceClient<T>)
Dispose() (Inherited from ServiceClient<T>)
Dispose(Boolean) (Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClient, HttpClientHandler, DelegatingHandler[]) (Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClientHandler, DelegatingHandler[]) (Inherited from ServiceClient<T>)
SetRetryPolicy(RetryPolicy) (Inherited from ServiceClient<T>)
SetUserAgent(String) (Inherited from ServiceClient<T>)
SetUserAgent(String, String) (Inherited from ServiceClient<T>)

Extension Methods

GetLongRunningOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for long running operations.

GetLongRunningOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for long running operations.

GetLongRunningOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for long running operations.

GetLongRunningOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for long running operations.

GetPostOrDeleteOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for DELETE and POST operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPostOrDeleteOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for DELETE and POST operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPostOrDeleteOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for DELETE and POST operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPostOrDeleteOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for DELETE and POST operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPutOrPatchOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for PUT and PATCH operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPutOrPatchOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for PUT and PATCH operations. (Deprecated, please use GetLongRunningOperationResultAsync)

GetPutOrPatchOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

Gets operation result for PUT and PATCH operations. (Deprecated, please use GetLongRunningOperationResultAsync)

Applies to