BatchClient Class

Definition

public class BatchClient
type BatchClient = class
Public Class BatchClient
Inheritance
BatchClient

Constructors

BatchClient()
BatchClient(IAzureContext)

Creates new BatchClient

BatchClient(IBatchManagementClient, IResourceManagementClient)

Creates new BatchClient instance

Properties

BatchManagementClient
ResourceManagementClient

Methods

AddApplication(String, String, String, Nullable<Boolean>, String)
AddCertificate(NewCertificateParameters)
Obsolete.

Adds a certificate to the specified Batch account.

AddTaskCollection(NewBulkTaskParameters)

Adds a collection of tasks

CancelDeleteCertificate(CertificateOperationParameters)

Cancels a failed deletion of the specified certificate.

ChangeOSVersion(ChangeOSVersionParameters)
CreateAccount(AccountCreateParameters)

Creates a new Batch account

CreateComputeNodeUser(NewComputeNodeUserParameters)

Creates a new compute node user.

CreateJob(NewJobParameters)

Creates a new job.

CreateJobSchedule(NewJobScheduleParameters)

Creates a new job schedule.

CreatePool(NewPoolParameters)

Creates a new pool.

CreateTask(NewTaskParameters)

Creates a new task.

DeleteAccount(String, String)

Deletes the specified account

DeleteApplication(String, String, String)
DeleteApplicationPackage(String, String, String, String)
DeleteCertificate(CertificateOperationParameters)

Deletes the specified certificate.

DeleteComputeNodeUser(ComputeNodeUserOperationParameters)

Deletes the specified compute node user.

DeleteJob(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Deletes the specified job.

DeleteJobSchedule(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Deletes the specified job schedule.

DeleteNodeFile(Nullable<Boolean>, NodeFileOperationParameters)

Deletes the specified file from its compute node.

DeletePool(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Deletes the specified pool.

DeleteTask(TaskOperationParameters)

Deletes the specified task.

DisableAutoScale(PoolOperationParameters)

Disables automatic scaling on the specified pool.

DisableComputeNodeScheduling(DisableComputeNodeSchedulingParameters)

Disables task scheduling on the specified compute node.

DisableJob(DisableJobParameters)

Disables the specified job.

DisableJobSchedule(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Disables the specified job schedule.

DownloadNodeFile(DownloadNodeFileOptions)

Downloads a node file using the specified options.

DownloadRemoteDesktopProtocolFile(DownloadRemoteDesktopProtocolFileOptions)

Downloads a Remote Desktop Protocol file using the specified options.

EnableAutoScale(EnableAutoScaleParameters)

Enables automatic scaling on the specified pool.

EnableComputeNodeScheduling(ComputeNodeOperationParameters)

Enables task scheduling on the specified compute node.

EnableJob(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Enables the specified job.

EnableJobSchedule(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Enables the specified job schedule.

EvaluateAutoScale(EvaluateAutoScaleParameters)

Gets the result of evaluating an automatic scaling formula on the specified pool.

GetAccount(String, String)

Get details about the Batch account

GetAllJobsLifetimeStatistics(BatchAccountContext, IEnumerable<BatchClientBehavior>)
GetAllPoolsLifetimeStatistics(BatchAccountContext, IEnumerable<BatchClientBehavior>)
GetApplication(String, String, String)
GetApplicationPackage(String, String, String, String)
GetKeys(String, String)

Gets the keys associated with the Batch account

GetLocationQuotas(String)

Gets the Batch service quotas for the specified subscription at the given region.

GetPrivateEndpointConnection(String, String, String)
GetPrivateLinkResource(String, String, String)
GetSupportedVirtualMachineSku(String, Nullable<Int32>, String)
GetSupportedVirtualMachineSku(String)
GetTaskCounts(GetTaskCountsOptions)

Get task counts for the specified job.

GetTaskSlotCounts(GetTaskCountsOptions)

Get task slot counts for the specified job.

ListAccounts(Hashtable, String)

Lists all accounts in a subscription or in a resource group if its name is specified

ListApplicationPackages(String, String, String)
ListApplications(String, String)
ListCertificates(ListCertificateOptions)
Obsolete.

Lists the certificates matching the specified filter options.

ListComputeNodeExtension(ListComputeNodeExtensionParameters)

Lists the compute node extensions matching the specified filter options.

ListComputeNodeRemoteLoginSettings(ComputeNodeOperationParameters)

Get the settings required for remote login to a compute node

ListComputeNodes(ListComputeNodeOptions)

Lists the compute nodes matching the specified filter options.

ListJobPreparationAndReleaseStatus(ListJobPreparationAndReleaseStatusOptions)

Lists the job prep and release status matching the specified filter options.

ListJobs(ListJobOptions)

Lists the jobs matching the specified filter options.

ListJobSchedules(ListJobScheduleOptions)

Lists the job schedules matching the specified filter options.

ListNodeAgentSkus(BatchAccountContext, String, Int32, IEnumerable<BatchClientBehavior>)
ListNodeFiles(ListNodeFileOptions)

Lists the node files matching the specified filter options.

ListPoolNodeCounts(ListPoolNodeCountsOptions)

Lists the pool node counts matching the specified filter options.

ListPools(ListPoolOptions)

Lists the pools matching the specified filter options.

ListPoolUsageMetrics(ListPoolUsageOptions)

Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.

ListPrivateEndpointConnections(String, String, Nullable<Int32>)

Lists private endpoint connections

ListPrivateLinkResources(String, String, Nullable<Int32>)

Lists private link resources

ListSubtasks(ListSubtaskOptions)

Lists the subtasks matching the specified filter options.

ListSupportedImages(BatchAccountContext, String, Int32, IEnumerable<BatchClientBehavior>)

Lists the node agent SKUs matching the specified filter options.

ListTasks(ListTaskOptions)

Lists the tasks matching the specified filter options.

ReactivateTask(TaskOperationParameters)

Reactivates a task, allowing it to run again even if its retry count has been exhausted.

RebootComputeNode(RebootComputeNodeParameters)

Reboots the specified compute node.

RegenerateKeys(String, String, AccountKeyType)

Generates new key for the Batch account

ReimageComputeNode(ReimageComputeNodeParameters)

Reinstalls the operating system on the specified compute node.

RemoveComputeNodesFromPool(RemoveComputeNodeParameters)

Removes the specified compute nodes from the specified pool.

ResizePool(PoolResizeParameters)

Resizes the specified pool.

StartComputeNodeServiceLogUpload(StartComputeNodeServiceLogUploadParameters)
StopResizePool(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Stops the resize operation on the specified pool.

TerminateJob(TerminateJobParameters)

Terminates the specified job.

TerminateJobSchedule(BatchAccountContext, String, IEnumerable<BatchClientBehavior>)

Terminates the specified job schedule.

TerminateTask(TaskOperationParameters)

Terminates the specified task.

UpdateAccount(String, String, Hashtable, String)

Updates an existing Batch account

UpdateApplication(String, String, String, Nullable<Boolean>, String, String)
UpdateComputeNodeUser(UpdateComputeNodeUserParameters)

Updates a compute node user account

UpdateJob(BatchAccountContext, PSCloudJob, IEnumerable<BatchClientBehavior>)

Commits changes to a PSCloudJob object to the Batch Service.

UpdateJobSchedule(BatchAccountContext, PSCloudJobSchedule, IEnumerable<BatchClientBehavior>)

Commits changes to a PSCloudJobSchedule object to the Batch Service.

UpdatePool(BatchAccountContext, PSCloudPool, IEnumerable<BatchClientBehavior>)

Commits changes to a PSCloudPool object to the Batch Service.

UpdatePrivateEndpointConnection(String, String, String, PrivateLinkServiceConnectionStatus, String)
UpdateTask(BatchAccountContext, PSCloudTask, IEnumerable<BatchClientBehavior>)

Commits changes to a PSCloudTask object to the Batch Service.

UploadAndActivateApplicationPackage(String, String, String, String, String, String, Boolean)

Applies to