Workspaces Interface

public interface Workspaces

Resource collection API of Workspaces.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Workspace resource.

abstract void deleteById(String id)

Remove a workspace.

abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Remove a workspace.

abstract void deleteByResourceGroup(String resourceGroupName, String workspaceName)

Remove a workspace.

abstract Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Remove a workspace.

abstract Workspace getById(String id)

Get a workspace.

abstract Response<Workspace> getByIdWithResponse(String id, Context context)

Get a workspace.

abstract Workspace getByResourceGroup(String resourceGroupName, String workspaceName)

Get a workspace.

abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Get a workspace.

abstract PagedIterable<Workspace> list()

List workspaces in subscription.

abstract PagedIterable<Workspace> list(Context context)

List workspaces in subscription.

abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

List workspaces.

abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List workspaces.

Method Details

define

public abstract 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.

deleteById

public abstract void deleteById(String id)

Remove a workspace.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Remove a workspace.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String workspaceName)

Remove a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.

deleteByResourceGroupWithResponse

public abstract Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Remove a 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:

getById

public abstract Workspace getById(String id)

Get a workspace.

Parameters:

id - the resource ID.

Returns:

a workspace along with Response<T>.

getByIdWithResponse

public abstract Response<Workspace> getByIdWithResponse(String id, Context context)

Get a workspace.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a workspace along with Response<T>.

getByResourceGroup

public abstract Workspace getByResourceGroup(String resourceGroupName, String workspaceName)

Get a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.

Returns:

a workspace.

getByResourceGroupWithResponse

public abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Get a 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:

a workspace along with Response<T>.

list

public abstract PagedIterable<Workspace> list()

List workspaces in subscription.

Returns:

workspaceList as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Workspace> list(Context context)

List workspaces in subscription.

Parameters:

context - The context to associate with this operation.

Returns:

workspaceList as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

List workspaces.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

workspaceList as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, Integer pageSize, Boolean isDescending, Integer initialSkip, Context context)

List workspaces.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
pageSize - Number of items per page.
isDescending - Indicates whether the collection is descending.
initialSkip - Initial number of items to skip.
context - The context to associate with this operation.

Returns:

workspaceList as paginated response with PagedIterable<T>.

Applies to