Package com.azure.resourcemanager.batch.models

Interface Pools

public interface Pools
Resource collection API of Pools.

  • Method Details

    • listByBatchAccount

      com.azure.core.http.rest.PagedIterable<Pool> 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByBatchAccount

      com.azure.core.http.rest.PagedIterable<Pool> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String accountName, String poolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<Pool> getWithResponse(String resourceGroupName, String accountName, String poolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      Pool 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableAutoScaleWithResponse

      com.azure.core.http.rest.Response<Pool> disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableAutoScale

      Pool 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopResizeWithResponse

      com.azure.core.http.rest.Response<Pool> stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopResize

      Pool 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      Pool getById(String id)
      Gets information about the specified pool.
      Parameters:
      id - the resource ID.
      Returns:
      information about the specified pool.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Pool> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets information about the specified pool.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      information about the specified pool.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Deletes the specified pool.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the specified pool.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      Pool.DefinitionStages.Blank define(String name)
      Begins definition for a new Pool resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Pool definition.