Workspaces Interface

Package:

com.azure.resourcemanager.synapse.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-synapse:1.0.0

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 Object	delete(String resourceGroupName, String workspaceName, Context context) Deletes a workspace.
abstract Object	deleteById(String id) Deletes a workspace.
abstract Object	deleteByIdWithResponse(String id, Context context) Deletes a workspace.
abstract Object	deleteByResourceGroup(String resourceGroupName, String workspaceName) Deletes a workspace.
abstract Workspace	getById(String id) Gets a workspace.
abstract Response<Workspace>	getByIdWithResponse(String id, Context context) Gets a workspace.
abstract Workspace	getByResourceGroup(String resourceGroupName, String workspaceName) Gets a workspace.
abstract Response<Workspace>	getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context) Gets a workspace.
abstract PagedIterable<Workspace>	list() Returns a list of workspaces in a subscription.
abstract PagedIterable<Workspace>	list(Context context) Returns a list of workspaces in a subscription.
abstract PagedIterable<Workspace>	listByResourceGroup(String resourceGroupName) Returns a list of workspaces in a resource group.
abstract PagedIterable<Workspace>	listByResourceGroup(String resourceGroupName, Context context) Returns a list of workspaces in a resource group.

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.

delete

public abstract Object delete(String resourceGroupName, String workspaceName, Context context)

Deletes 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:

any object.

deleteById

public abstract Object deleteById(String id)

Deletes a workspace.

Parameters:

id - the resource ID.

Returns:

any object.

deleteByIdWithResponse

public abstract Object deleteByIdWithResponse(String id, Context context)

Deletes a workspace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

any object.

deleteByResourceGroup

public abstract Object deleteByResourceGroup(String resourceGroupName, String workspaceName)

Deletes a workspace.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

any object.

getById

public abstract Workspace getById(String id)

Gets a workspace.

Parameters:

id - the resource ID.

Returns:

a workspace along with Response<T>.

getByIdWithResponse

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

Gets 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)

Gets 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)

Gets 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()

Returns a list of workspaces in a subscription.

Returns:

list of workspaces as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Workspace> list(Context context)

Returns a list of workspaces in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

list of workspaces as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

Returns a list of workspaces in a resource group.

Parameters:

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

Returns:

list of workspaces as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, Context context)

Returns a list of 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:

list of workspaces as paginated response with PagedIterable<T>.