Interface Workspaces
public interface Workspaces
Resource collection API of Workspaces.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Workspace resource.void
Deletes the workspace.void
deleteById
(String id) Deletes the workspace.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes the workspace.void
deleteByResourceGroup
(String resourceGroupName, String workspaceName) Deletes the workspace.Gets the workspace.com.azure.core.http.rest.Response<Workspace>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets the workspace.getByResourceGroup
(String resourceGroupName, String workspaceName) Gets the workspace.com.azure.core.http.rest.Response<Workspace>
getByResourceGroupWithResponse
(String resourceGroupName, String workspaceName, com.azure.core.util.Context context) Gets the workspace.com.azure.core.http.rest.PagedIterable<Workspace>
list()
Gets all the workspaces within a subscription.com.azure.core.http.rest.PagedIterable<Workspace>
list
(com.azure.core.util.Context context) Gets all the workspaces within a subscription.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup
(String resourceGroupName) Gets all the workspaces within a resource group.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Gets all the workspaces within a resource group.
-
Method Details
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context) Gets the workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.context
- The context to associate with this operation.- Returns:
- the workspace along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
Gets the workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Returns:
- the workspace.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByResourceGroup
Deletes the workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Deletes the workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
Gets all the workspaces within a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- all the workspaces within a resource group as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- 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<Workspace> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Gets all the workspaces within a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- all the workspaces within a resource group as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- 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<Workspace> list()Gets all the workspaces within a subscription.- Returns:
- all the workspaces within a subscription as paginated response with
PagedIterable
. - Throws:
ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
Gets all the workspaces within a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- all the workspaces within a subscription as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
Gets the workspace.- Parameters:
id
- the resource ID.- Returns:
- the workspace along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- 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<Workspace> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets the workspace.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the workspace along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
Deletes the workspace.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
Deletes the workspace.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.ErrorInfoException
- 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 Workspace resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Workspace definition.
-