Package com.azure.resourcemanager.healthcareapis.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 workspace)	Creates or updates a workspace resource with the specified parameters.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspace, com.azure.core.util.Context context)	Creates or updates a workspace resource with the specified parameters.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String workspaceName)	Deletes a specified workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Deletes a specified workspace.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginUpdate(String resourceGroupName, String workspaceName, WorkspacePatchResource workspacePatchResource)	Patch workspace details.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner>	beginUpdate(String resourceGroupName, String workspaceName, WorkspacePatchResource workspacePatchResource, com.azure.core.util.Context context)	Patch workspace details.
WorkspaceInner	createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspace)	Creates or updates a workspace resource with the specified parameters.
WorkspaceInner	createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner workspace, com.azure.core.util.Context context)	Creates or updates a workspace resource with the specified parameters.
void	delete(String resourceGroupName, String workspaceName)	Deletes a specified workspace.
void	delete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Deletes a specified workspace.
WorkspaceInner	getByResourceGroup(String resourceGroupName, String workspaceName)	Gets the properties of the specified workspace.
com.azure.core.http.rest.Response<WorkspaceInner>	getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Gets the properties of the specified workspace.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	list()	Lists all the available workspaces under the specified subscription.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	list(com.azure.core.util.Context context)	Lists all the available workspaces under the specified subscription.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	listByResourceGroup(String resourceGroupName)	Lists all the available workspaces under the specified resource group.
com.azure.core.http.rest.PagedIterable<WorkspaceInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Lists all the available workspaces under the specified resource group.
WorkspaceInner	update(String resourceGroupName, String workspaceName, WorkspacePatchResource workspacePatchResource)	Patch workspace details.
WorkspaceInner	update(String resourceGroupName, String workspaceName, WorkspacePatchResource workspacePatchResource, com.azure.core.util.Context context)	Patch workspace details.

Method Detail

list

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

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

beginCreateOrUpdate

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

Creates or updates a workspace resource with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspace - The parameters for creating or updating a healthcare workspace.

Returns:

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

beginCreateOrUpdate

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

Creates or updates a workspace resource with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspace - The parameters for creating or updating a healthcare workspace.

context - The context to associate with this operation.

Returns:

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

createOrUpdate

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

Creates or updates a workspace resource with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspace - The parameters for creating or updating a healthcare workspace.

Returns:

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.

createOrUpdate

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

Creates or updates a workspace resource with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspace - The parameters for creating or updating a healthcare workspace.

context - The context to associate with this operation.

Returns:

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.

beginUpdate

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

Patch workspace details.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspacePatchResource - The parameters for updating a specified workspace.

Returns:

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

beginUpdate

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

Patch workspace details.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspacePatchResource - The parameters for updating a specified workspace.

context - The context to associate with this operation.

Returns:

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

update

WorkspaceInner update(String resourceGroupName,
                      String workspaceName,
                      WorkspacePatchResource workspacePatchResource)

Patch workspace details.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspacePatchResource - The parameters for updating a specified workspace.

Returns:

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.

update

WorkspaceInner update(String resourceGroupName,
                      String workspaceName,
                      WorkspacePatchResource workspacePatchResource,
                      com.azure.core.util.Context context)

Patch workspace details.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

workspaceName - The name of workspace resource.

workspacePatchResource - The parameters for updating a specified workspace.

context - The context to associate with this operation.

Returns:

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.

beginDelete

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

Returns:

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

beginDelete

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

Returns:

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

delete

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