Interface Pools
public interface Pools
Resource collection API of Pools.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Pool resource.void
Deletes a machine pool.void
delete
(String resourceGroupName, String projectName, String poolName, com.azure.core.util.Context context) Deletes a machine pool.void
deleteById
(String id) Deletes a machine pool.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a machine pool.Gets a machine pool.Gets a machine pool.com.azure.core.http.rest.Response<Pool>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a machine pool.com.azure.core.http.rest.Response<Pool>
getWithResponse
(String resourceGroupName, String projectName, String poolName, com.azure.core.util.Context context) Gets a machine pool.com.azure.core.http.rest.PagedIterable<Pool>
listByProject
(String resourceGroupName, String projectName) Lists pools for a project.com.azure.core.http.rest.PagedIterable<Pool>
listByProject
(String resourceGroupName, String projectName, Integer top, com.azure.core.util.Context context) Lists pools for a project.
-
Method Details
-
listByProject
com.azure.core.http.rest.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
. - 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.
-
listByProject
com.azure.core.http.rest.PagedIterable<Pool> listByProject(String resourceGroupName, String projectName, Integer top, com.azure.core.util.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
. - 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 projectName, String poolName, com.azure.core.util.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
. - 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
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.
- 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
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.- 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 projectName, String poolName, com.azure.core.util.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.- 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
Gets a machine pool.- Parameters:
id
- the resource ID.- Returns:
- a machine pool along with
Response
. - 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 a machine pool.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a machine pool along with
Response
. - 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
Deletes a machine 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
Deletes a machine 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
Begins definition for a new Pool resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Pool definition.
-