Package com.azure.resourcemanager.synapse.fluent

Interface WorkspacesClient

public interface WorkspacesClient

An instance of this class provides access to all the operations defined in WorkspacesClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspaceInfo)	Creates or updates a workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspaceInfo, com.azure.core.util.Context context)	Creates or updates a workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginDelete(String resourceGroupName, String workspaceName)	Deletes a workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginDelete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Deletes a workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginUpdate(String resourceGroupName, String workspaceName, WorkspacePatchInfo workspacePatchInfo)	Updates a workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginUpdate(String resourceGroupName, String workspaceName, WorkspacePatchInfo workspacePatchInfo, com.azure.core.util.Context context)	Updates a workspace.
WorkspaceInner	createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspaceInfo)	Creates or updates a workspace.
WorkspaceInner	createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspaceInfo, com.azure.core.util.Context context)	Creates or updates a workspace.
Object	delete(String resourceGroupName, String workspaceName)	Deletes a workspace.
Object	delete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Deletes a workspace.
WorkspaceInner	getByResourceGroup(String resourceGroupName, String workspaceName)	Gets a workspace.
com.azure.core.http.rest.Response<WorkspaceInner>	getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Gets a workspace.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	list()	Returns a list of workspaces in a subscription.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	list(com.azure.core.util.Context context)	Returns a list of workspaces in a subscription.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	listByResourceGroup(String resourceGroupName)	Returns a list of workspaces in a resource group.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns a list of workspaces in a resource group.
WorkspaceInner	update(String resourceGroupName, String workspaceName, WorkspacePatchInfo workspacePatchInfo)	Updates a workspace.
WorkspaceInner	update(String resourceGroupName, String workspaceName, WorkspacePatchInfo workspacePatchInfo, com.azure.core.util.Context context)	Updates a workspace.

Method Detail

listByResourceGroup

com.azure.core.http.rest.PagedIterable<WorkspaceInner> 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.

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<WorkspaceInner> listByResourceGroup(String resourceGroupName,
                                                                           com.azure.core.util.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.

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

WorkspaceInner 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.

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<WorkspaceInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                 String workspaceName,
                                                                                 com.azure.core.util.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.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName,
                                                                                                                                      String workspaceName,
                                                                                                                                      WorkspacePatchInfo workspacePatchInfo)

Updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspacePatchInfo - Workspace patch request properties.

Returns:

the SyncPoller for polling of a 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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner> beginUpdate(String resourceGroupName,
                                                                                                                                      String workspaceName,
                                                                                                                                      WorkspacePatchInfo workspacePatchInfo,
                                                                                                                                      com.azure.core.util.Context context)

Updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspacePatchInfo - Workspace patch request properties.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of a 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.

update

WorkspaceInner update(String resourceGroupName,
                      String workspaceName,
                      WorkspacePatchInfo workspacePatchInfo)

Updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspacePatchInfo - Workspace patch request properties.

Returns:

a 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.

update

WorkspaceInner update(String resourceGroupName,
                      String workspaceName,
                      WorkspacePatchInfo workspacePatchInfo,
                      com.azure.core.util.Context context)

Updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspacePatchInfo - Workspace patch request properties.

context - The context to associate with this operation.

Returns:

a 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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                              String workspaceName,
                                                                                                                                              WorkspaceInner workspaceInfo)

Creates or updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspaceInfo - Workspace create or update request properties.

Returns:

the SyncPoller for polling of a 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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                              String workspaceName,
                                                                                                                                              WorkspaceInner workspaceInfo,
                                                                                                                                              com.azure.core.util.Context context)

Creates or updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspaceInfo - Workspace create or update request properties.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of a 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.

createOrUpdate

WorkspaceInner createOrUpdate(String resourceGroupName,
                              String workspaceName,
                              WorkspaceInner workspaceInfo)

Creates or updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspaceInfo - Workspace create or update request properties.

Returns:

a 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.

createOrUpdate

WorkspaceInner createOrUpdate(String resourceGroupName,
                              String workspaceName,
                              WorkspaceInner workspaceInfo,
                              com.azure.core.util.Context context)

Creates or updates a workspace.

Parameters:

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

workspaceName - The name of the workspace.

workspaceInfo - Workspace create or update request properties.

context - The context to associate with this operation.

Returns:

a 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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginDelete(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:

the SyncPoller for polling of any object.

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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginDelete(String resourceGroupName,
                                                                                                                      String workspaceName,
                                                                                                                      com.azure.core.util.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:

the SyncPoller for polling of any object.

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

Object delete(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.

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

Object delete(String resourceGroupName,
              String workspaceName,
              com.azure.core.util.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.

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.

list

com.azure.core.http.rest.PagedIterable<WorkspaceInner> list()

Returns a list of workspaces in a subscription.

Returns:

list of workspaces 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<WorkspaceInner> list(com.azure.core.util.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.

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.