Pools Interface

public interface Pools

Resource collection API of Pools.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Pool resource.

abstract void delete(String resourceGroupName, String projectName, String poolName)

Deletes a machine pool.

abstract void delete(String resourceGroupName, String projectName, String poolName, Context context)

Deletes a machine pool.

abstract void deleteById(String id)

Deletes a machine pool.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes a machine pool.

abstract Pool get(String resourceGroupName, String projectName, String poolName)

Gets a machine pool.

abstract Pool getById(String id)

Gets a machine pool.

abstract Response<Pool> getByIdWithResponse(String id, Context context)

Gets a machine pool.

abstract Response<Pool> getWithResponse(String resourceGroupName, String projectName, String poolName, Context context)

Gets a machine pool.

abstract PagedIterable<Pool> listByProject(String resourceGroupName, String projectName)

Lists pools for a project.

abstract PagedIterable<Pool> listByProject(String resourceGroupName, String projectName, Integer top, Context context)

Lists pools for a project.

abstract void runHealthChecks(String resourceGroupName, String projectName, String poolName)

Triggers a refresh of the pool status.

abstract void runHealthChecks(String resourceGroupName, String projectName, String poolName, Context context)

Triggers a refresh of the pool status.

Method Details

define

public abstract 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.

delete

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

Deletes a machine pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.

delete

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

Deletes a machine pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a machine pool.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a machine pool.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract Pool get(String resourceGroupName, String projectName, String poolName)

Gets a machine pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.

Returns:

a machine pool.

getById

public abstract Pool getById(String id)

Gets a machine pool.

Parameters:

id - the resource ID.

Returns:

a machine pool along with Response<T>.

getByIdWithResponse

public abstract Response<Pool> getByIdWithResponse(String id, Context context)

Gets a machine pool.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a machine pool along with Response<T>.

getWithResponse

public abstract Response<Pool> getWithResponse(String resourceGroupName, String projectName, String poolName, Context context)

Gets a machine pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.
context - The context to associate with this operation.

Returns:

a machine pool along with Response<T>.

listByProject

public abstract PagedIterable<Pool> listByProject(String resourceGroupName, String projectName)

Lists pools for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.

Returns:

results of the machine pool list operation as paginated response with PagedIterable<T>.

listByProject

public abstract PagedIterable<Pool> listByProject(String resourceGroupName, String projectName, Integer top, Context context)

Lists pools for a project.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
context - The context to associate with this operation.

Returns:

results of the machine pool list operation as paginated response with PagedIterable<T>.

runHealthChecks

public abstract void runHealthChecks(String resourceGroupName, String projectName, String poolName)

Triggers a refresh of the pool status.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.

runHealthChecks

public abstract void runHealthChecks(String resourceGroupName, String projectName, String poolName, Context context)

Triggers a refresh of the pool status.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
projectName - The name of the project.
poolName - Name of the pool.
context - The context to associate with this operation.

Applies to