Interface Workspaces
public interface Workspaces
Resource collection API of Workspaces.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Workspace resource.void
Deletes a workspace resource.void
Deletes a workspace resource.void
delete
(String resourceGroupName, String workspaceName, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource.void
deleteById
(String id) Deletes a workspace resource.void
deleteByIdWithResponse
(String id, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource.Gets a workspace instance.com.azure.core.http.rest.Response<Workspace>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a workspace instance.getByResourceGroup
(String resourceGroupName, String workspaceName) Gets a workspace instance.com.azure.core.http.rest.Response<Workspace>
getByResourceGroupWithResponse
(String resourceGroupName, String workspaceName, com.azure.core.util.Context context) Gets a workspace instance.com.azure.core.http.rest.PagedIterable<Workspace>
list()
Gets the workspaces in a subscription.com.azure.core.http.rest.PagedIterable<Workspace>
list
(com.azure.core.util.Context context) Gets the workspaces in a subscription.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup
(String resourceGroupName) Gets workspaces in a resource group.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Gets workspaces in a resource group.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<Workspace> list()Gets the workspaces in a subscription.- Returns:
- the workspaces in a subscription 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
Gets the workspaces in a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- the workspaces in a subscription 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
Gets workspaces in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- workspaces in a resource group 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<Workspace> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Gets workspaces in 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:
- workspaces in a resource group 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
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.- 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 workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- 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.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 workspaceName, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.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.
-
getByResourceGroup
Gets a workspace instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Returns:
- a workspace instance.
- 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<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context) Gets a workspace instance.- 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:
- a workspace instance 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.
-
getById
Gets a workspace instance.- Parameters:
id
- the resource ID.- Returns:
- a workspace instance 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<Workspace> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets a workspace instance.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a workspace instance 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 workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- 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 workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
id
- the resource ID.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.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 Workspace resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Workspace definition.
-