Interface Projects
public interface Projects
Resource collection API of Projects.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Project resource.void
Deletes a project resource.void
deleteById
(String id) Deletes a project resource.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a project resource.void
deleteByResourceGroup
(String resourceGroupName, String projectName) Deletes a project resource.Gets a specific project.com.azure.core.http.rest.Response<Project>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a specific project.getByResourceGroup
(String resourceGroupName, String projectName) Gets a specific project.com.azure.core.http.rest.Response<Project>
getByResourceGroupWithResponse
(String resourceGroupName, String projectName, com.azure.core.util.Context context) Gets a specific project.com.azure.core.http.rest.PagedIterable<Project>
list()
Lists all projects in the subscription.com.azure.core.http.rest.PagedIterable<Project>
Lists all projects in the subscription.com.azure.core.http.rest.PagedIterable<Project>
listByResourceGroup
(String resourceGroupName) Lists all projects in the resource group.com.azure.core.http.rest.PagedIterable<Project>
listByResourceGroup
(String resourceGroupName, Integer top, com.azure.core.util.Context context) Lists all projects in the resource group.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<Project> list()Lists all projects in the subscription.- Returns:
- results of the project list operation as paginated response with
PagedIterable
. - Throws:
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.
-
list
com.azure.core.http.rest.PagedIterable<Project> list(Integer top, com.azure.core.util.Context context) Lists all projects in the subscription.- Parameters:
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 project 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.
-
listByResourceGroup
Lists all projects in the resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- results of the project 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<Project> listByResourceGroup(String resourceGroupName, Integer top, com.azure.core.util.Context context) Lists all projects in the resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.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 project 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Project> getByResourceGroupWithResponse(String resourceGroupName, String projectName, com.azure.core.util.Context context) Gets a specific project.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.projectName
- The name of the project.context
- The context to associate with this operation.- Returns:
- a specific project 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.
-
getByResourceGroup
Gets a specific project.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.projectName
- The name of the project.- Returns:
- a specific project.
- 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.
-
deleteByResourceGroup
Deletes a project resource.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.projectName
- The name of the project.- 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 project resource.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.projectName
- The name of the project.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 specific project.- Parameters:
id
- the resource ID.- Returns:
- a specific project 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<Project> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets a specific project.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a specific project 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 project resource.- 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 project resource.- 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 Project resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Project definition.
-