Share via

PoolsClient Interface

Package:
com.azure.resourcemanager.batch.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0

public interface PoolsClient

An instance of this class provides access to all the operations defined in PoolsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String poolName)

Deletes the specified pool.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String poolName, Context context)

Deletes the specified pool.
abstract PoolInner create(String resourceGroupName, String accountName, String poolName, PoolInner parameters)

Creates a new pool inside the specified account.
abstract PoolsCreateResponse createWithResponse(String resourceGroupName, String accountName, String poolName, PoolInner parameters, String ifMatch, String ifNoneMatch, Context context)

Creates a new pool inside the specified account.
abstract void delete(String resourceGroupName, String accountName, String poolName)

Deletes the specified pool.
abstract void delete(String resourceGroupName, String accountName, String poolName, Context context)

Deletes the specified pool.
abstract PoolInner disableAutoScale(String resourceGroupName, String accountName, String poolName)

Disables automatic scaling for a pool.
abstract PoolsDisableAutoScaleResponse disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Disables automatic scaling for a pool.
abstract PoolInner get(String resourceGroupName, String accountName, String poolName)

Gets information about the specified pool.
abstract PoolsGetResponse getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Gets information about the specified pool.
abstract PagedIterable<PoolInner> listByBatchAccount(String resourceGroupName, String accountName)

Lists all of the pools in the specified account.
abstract PagedIterable<PoolInner> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)

Lists all of the pools in the specified account.
abstract PoolInner stopResize(String resourceGroupName, String accountName, String poolName)

Stops an ongoing resize operation on the pool.
abstract PoolsStopResizeResponse stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Stops an ongoing resize operation on the pool.
abstract PoolInner update(String resourceGroupName, String accountName, String poolName, PoolInner parameters)

Updates the properties of an existing pool.
abstract PoolsUpdateResponse updateWithResponse(String resourceGroupName, String accountName, String poolName, PoolInner parameters, String ifMatch, Context context)

Updates the properties of an existing pool.

Method Details

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String poolName)

Deletes the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String poolName, Context context)

Deletes the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

create

public abstract PoolInner create(String resourceGroupName, String accountName, String poolName, PoolInner parameters)

Creates a new pool inside the specified account.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
parameters - Additional parameters for pool creation.

Returns:

contains information about a pool.

createWithResponse

public abstract PoolsCreateResponse createWithResponse(String resourceGroupName, String accountName, String poolName, PoolInner parameters, String ifMatch, String ifNoneMatch, Context context)

Creates a new pool inside the specified account.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
parameters - Additional parameters for pool creation.
ifMatch - The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.
ifNoneMatch - Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.
context - The context to associate with this operation.

Returns:

contains information about a pool.

delete

public abstract void delete(String resourceGroupName, String accountName, String poolName)

Deletes the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.

delete

public abstract void delete(String resourceGroupName, String accountName, String poolName, Context context)

Deletes the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
context - The context to associate with this operation.

disableAutoScale

public abstract PoolInner disableAutoScale(String resourceGroupName, String accountName, String poolName)

Disables automatic scaling for a pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.

Returns:

contains information about a pool.

disableAutoScaleWithResponse

public abstract PoolsDisableAutoScaleResponse disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Disables automatic scaling for a pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
context - The context to associate with this operation.

Returns:

contains information about a pool.

get

public abstract PoolInner get(String resourceGroupName, String accountName, String poolName)

Gets information about the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.

Returns:

information about the specified pool.

getWithResponse

public abstract PoolsGetResponse getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Gets information about the specified pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
context - The context to associate with this operation.

Returns:

information about the specified pool.

listByBatchAccount

public abstract PagedIterable<PoolInner> listByBatchAccount(String resourceGroupName, String accountName)

Lists all of the pools in the specified account.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.

Returns:

values returned by the List operation as paginated response with PagedIterable<T>.

listByBatchAccount

public abstract PagedIterable<PoolInner> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)

Lists all of the pools in the specified account.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
maxresults - The maximum number of items to return in the response.
select - Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection.
filter - OData filter expression. Valid properties for filtering are: name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale.
context - The context to associate with this operation.

Returns:

values returned by the List operation as paginated response with PagedIterable<T>.

stopResize

public abstract PoolInner stopResize(String resourceGroupName, String accountName, String poolName)

Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.

Returns:

contains information about a pool.

stopResizeWithResponse

public abstract PoolsStopResizeResponse stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)

Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
context - The context to associate with this operation.

Returns:

contains information about a pool.

update

public abstract PoolInner update(String resourceGroupName, String accountName, String poolName, PoolInner parameters)

Updates the properties of an existing pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
parameters - Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

Returns:

contains information about a pool.

updateWithResponse

public abstract PoolsUpdateResponse updateWithResponse(String resourceGroupName, String accountName, String poolName, PoolInner parameters, String ifMatch, Context context)

Updates the properties of an existing pool.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
poolName - The pool name. This must be unique within the account.
parameters - Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.
ifMatch - The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.
context - The context to associate with this operation.

Returns:

contains information about a pool.

Applies to