PoolOperations Class

Definition

Performs pool-related operations on an Azure Batch account.

public class PoolOperations : Microsoft.Azure.Batch.IInheritedBehaviors
type PoolOperations = class
    interface IInheritedBehaviors
Public Class PoolOperations
Implements IInheritedBehaviors
Inheritance
PoolOperations
Implements

Properties

CustomBehaviors

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

Methods

CopyNodeFileContentToStream(String, String, String, Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>)

Copies the contents of a file from the specified node to the given Stream.

CopyNodeFileContentToStreamAsync(String, String, String, Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>, CancellationToken)

Copies the contents of a file from the specified node to the given Stream.

CopyNodeFileContentToString(String, String, String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>)

Reads the contents of a file from the specified node into a string.

CopyNodeFileContentToStringAsync(String, String, String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>, CancellationToken)

Reads the contents of a file from the specified node into a string.

CreateComputeNodeUser(String, String)

Creates a ComputeNodeUser representing a new compute node user account that does not yet exist in the Batch service.

CreatePool()

Creates an instance of CloudPool that is unbound and does not have a consistency relationship to any pool in the Batch service.

CreatePool(String, String, CloudServiceConfiguration, Nullable<Int32>, Nullable<Int32>)

Creates an instance of CloudPool that is unbound and does not have a consistency relationship to any pool in the Batch service.

CreatePool(String, String, VirtualMachineConfiguration, Nullable<Int32>, Nullable<Int32>)

Creates an instance of CloudPool that is unbound and does not have a consistency relationship to any pool in the Batch service.

DeleteComputeNodeUser(String, String, String, IEnumerable<BatchClientBehavior>)

Deletes the specified user account from the specified compute node.

DeleteComputeNodeUserAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Deletes the specified user account from the specified compute node.

DeleteNodeFile(String, String, String, Nullable<Boolean>, IEnumerable<BatchClientBehavior>)

Deletes the specified file from the specified compute node.

DeleteNodeFileAsync(String, String, String, Nullable<Boolean>, IEnumerable<BatchClientBehavior>, CancellationToken)

Deletes the specified file from the specified compute node.

DeletePool(String, IEnumerable<BatchClientBehavior>)

Deletes the specified pool.

DeletePoolAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Deletes the specified pool.

DisableAutoScale(String, IEnumerable<BatchClientBehavior>)

Disables automatic scaling on the specified pool.

DisableAutoScaleAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Disables automatic scaling on the specified pool.

DisableComputeNodeScheduling(String, String, Nullable<DisableComputeNodeSchedulingOption>, IEnumerable<BatchClientBehavior>)

Disables task scheduling on the specified compute node.

DisableComputeNodeSchedulingAsync(String, String, Nullable<DisableComputeNodeSchedulingOption>, IEnumerable<BatchClientBehavior>, CancellationToken)

Disables task scheduling on the specified compute node.

EnableAutoScale(String, String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Enables automatic scaling on the specified pool.

EnableAutoScaleAsync(String, String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Enables automatic scaling on the specified pool.

EnableComputeNodeScheduling(String, String, IEnumerable<BatchClientBehavior>)

Enables task scheduling on the specified compute node.

EnableComputeNodeSchedulingAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Enables task scheduling on the specified compute node.

EvaluateAutoScale(String, String, IEnumerable<BatchClientBehavior>)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

EvaluateAutoScaleAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

GetAllLifetimeStatistics(IEnumerable<BatchClientBehavior>)

Gets lifetime summary statistics for all of the pools in the current account.
Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

GetAllLifetimeStatisticsAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Gets lifetime summary statistics for all of the pools in the current account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

GetComputeNode(String, String, DetailLevel, IEnumerable<BatchClientBehavior>)

Gets the specified compute node.

GetComputeNodeAsync(String, String, DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the specified compute node.

GetNodeFile(String, String, String, IEnumerable<BatchClientBehavior>)

Gets information about a file on a compute node.

GetNodeFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets information about a file on a compute node.

GetPool(String, DetailLevel, IEnumerable<BatchClientBehavior>)

Gets the specified CloudPool.

GetPoolAsync(String, DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the specified CloudPool.

GetRDPFile(String, String, Stream, IEnumerable<BatchClientBehavior>)

Gets a Remote Desktop Protocol (RDP) file for the specified node.

GetRDPFile(String, String, String, IEnumerable<BatchClientBehavior>)

Gets a Remote Desktop Protocol file for the specified node.

GetRDPFileAsync(String, String, Stream, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets a Remote Desktop Protocol (RDP) file for the specified node.

GetRDPFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets a Remote Desktop Protocol file for the specified node.

GetRemoteLoginSettings(String, String, IEnumerable<BatchClientBehavior>)

Gets the settings required for remote login to a compute node.

GetRemoteLoginSettingsAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the settings required for remote login to a compute node.

ListComputeNodes(String, DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the ComputeNode of the specified pool.

ListNodeFiles(String, String, Nullable<Boolean>, DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates files on the specified compute node.

ListPoolNodeCounts(DetailLevel, IEnumerable<BatchClientBehavior>)

Lists the number of nodes in each state, grouped by pool.

ListPools(DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the CloudPool in the Batch account.

ListPoolUsageMetrics(Nullable<DateTime>, Nullable<DateTime>, DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates pool usage metrics.

ListSupportedImages(DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the node agent Sku values supported by Batch Service.

Reboot(String, String, Nullable<ComputeNodeRebootOption>, IEnumerable<BatchClientBehavior>)

Reboots the specified compute node.

RebootAsync(String, String, Nullable<ComputeNodeRebootOption>, IEnumerable<BatchClientBehavior>, CancellationToken)

Reboots the specified compute node.

Reimage(String, String, Nullable<ComputeNodeReimageOption>, IEnumerable<BatchClientBehavior>)

Reinstalls the operating system on the specified compute node.

ReimageAsync(String, String, Nullable<ComputeNodeReimageOption>, IEnumerable<BatchClientBehavior>, CancellationToken)

Reinstalls the operating system on the specified compute node.

RemoveFromPool(String, ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from the specified pool.

RemoveFromPool(String, IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute nodes from the specified pool.

RemoveFromPool(String, IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute nodes from the specified pool.

RemoveFromPool(String, String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from the specified pool.

RemoveFromPoolAsync(String, ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from the specified pool.

RemoveFromPoolAsync(String, IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute nodes from the specified pool.

RemoveFromPoolAsync(String, IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)

Removes the specified compute nodes from the specified pool.

RemoveFromPoolAsync(String, String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

Removes the specified compute node from the specified pool.

ResizePool(String, Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<ComputeNodeDeallocationOption>, IEnumerable<BatchClientBehavior>)

Resizes the specified pool.

ResizePoolAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<ComputeNodeDeallocationOption>, IEnumerable<BatchClientBehavior>, CancellationToken)

Resizes the specified pool.

StopResizePool(String, IEnumerable<BatchClientBehavior>)

Stops a pool resize operation.

StopResizePoolAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Stops a pool resize operation.

UploadComputeNodeBatchServiceLogs(String, String, String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>)

Upload Azure Batch service log files from the specified compute node.

UploadComputeNodeBatchServiceLogsAsync(String, String, String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)

Upload Azure Batch service log files from the specified compute node.

Applies to