Interface Workspaces
-
public interface Workspaces
Resource collection API of Workspaces.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Workspace.DefinitionStages.Blank
define(String name)
Begins definition for a new Workspace resource.void
delete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
Deletes a specified workspace.void
deleteById(String id)
Deletes a specified workspace.void
deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Deletes a specified workspace.void
deleteByResourceGroup(String resourceGroupName, String workspaceName)
Deletes a specified workspace.Workspace
getById(String id)
Gets the properties of the specified workspace.com.azure.core.http.rest.Response<Workspace>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Gets the properties of the specified workspace.Workspace
getByResourceGroup(String resourceGroupName, String workspaceName)
Gets the properties of the specified workspace.com.azure.core.http.rest.Response<Workspace>
getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
Gets the properties of the specified workspace.com.azure.core.http.rest.PagedIterable<Workspace>
list()
Lists all the available workspaces under the specified subscription.com.azure.core.http.rest.PagedIterable<Workspace>
list(com.azure.core.util.Context context)
Lists all the available workspaces under the specified subscription.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup(String resourceGroupName)
Lists all the available workspaces under the specified resource group.com.azure.core.http.rest.PagedIterable<Workspace>
listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
Lists all the available workspaces under the specified resource group.
-
-
-
Method Detail
-
list
com.azure.core.http.rest.PagedIterable<Workspace> list()
Lists all the available workspaces under the specified subscription.- Returns:
- collection of workspace object with a next link 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<Workspace> list(com.azure.core.util.Context context)
Lists all the available workspaces under the specified subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- collection of workspace object with a next link 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)
Lists all the available workspaces under the specified resource group.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.- Returns:
- collection of workspace object with a next link 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)
Lists all the available workspaces under the specified resource group.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.context
- The context to associate with this operation.- Returns:
- collection of workspace object with a next link 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.
-
getByResourceGroup
Workspace getByResourceGroup(String resourceGroupName, String workspaceName)
Gets the properties of the specified workspace.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.workspaceName
- The name of workspace resource.- Returns:
- the properties of the specified 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
Gets the properties of the specified workspace.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.workspaceName
- The name of workspace resource.context
- The context to associate with this operation.- Returns:
- the properties of the specified workspace 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.
-
deleteByResourceGroup
void deleteByResourceGroup(String resourceGroupName, String workspaceName)
Deletes a specified workspace.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.workspaceName
- The name of workspace resource.- 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, com.azure.core.util.Context context)
Deletes a specified workspace.- Parameters:
resourceGroupName
- The name of the resource group that contains the service instance.workspaceName
- The name of workspace resource.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
Workspace getById(String id)
Gets the properties of the specified workspace.- Parameters:
id
- the resource ID.- Returns:
- the properties of the specified workspace 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 the properties of the specified workspace.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the properties of the specified workspace 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
void deleteById(String id)
Deletes a specified workspace.- 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
void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Deletes a specified workspace.- 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
Workspace.DefinitionStages.Blank define(String name)
Begins definition for a new Workspace resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Workspace definition.
-
-