Interface WorkspacesClient
public interface WorkspacesClient
An instance of this class provides access to all the operations defined in WorkspacesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,
WorkspaceInner> beginCreateOrUpdate
(String resourceGroupName, String workspaceName, WorkspaceInner parameters) Create or update a workspace.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,
WorkspaceInner> beginCreateOrUpdate
(String resourceGroupName, String workspaceName, WorkspaceInner parameters, com.azure.core.util.Context context) Create or update a workspace.beginDelete
(String resourceGroupName, String workspaceName, Boolean force) Deletes a workspace resource.beginDelete
(String resourceGroupName, String workspaceName, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource.createOrUpdate
(String resourceGroupName, String workspaceName, WorkspaceInner parameters) Create or update a workspace.createOrUpdate
(String resourceGroupName, String workspaceName, WorkspaceInner parameters, com.azure.core.util.Context context) Create or update a workspace.void
Deletes a workspace resource.void
Deletes a workspace resource.void
delete
(String resourceGroupName, String workspaceName, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource.getByResourceGroup
(String resourceGroupName, String workspaceName) Gets a workspace instance.com.azure.core.http.rest.Response<WorkspaceInner>
getByResourceGroupWithResponse
(String resourceGroupName, String workspaceName, com.azure.core.util.Context context) Gets a workspace instance.com.azure.core.http.rest.PagedIterable<WorkspaceInner>
list()
Gets the workspaces in a subscription.com.azure.core.http.rest.PagedIterable<WorkspaceInner>
list
(com.azure.core.util.Context context) Gets the workspaces in a subscription.com.azure.core.http.rest.PagedIterable<WorkspaceInner>
listByResourceGroup
(String resourceGroupName) Gets workspaces in a resource group.com.azure.core.http.rest.PagedIterable<WorkspaceInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Gets workspaces in a resource group.update
(String resourceGroupName, String workspaceName, WorkspacePatch parameters) Updates a workspace.com.azure.core.http.rest.Response<WorkspaceInner>
updateWithResponse
(String resourceGroupName, String workspaceName, WorkspacePatch parameters, com.azure.core.util.Context context) Updates a workspace.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<WorkspaceInner> list()Gets the workspaces in a subscription.- Returns:
- the workspaces in a subscription 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
Gets the workspaces in a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- the workspaces in a subscription 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) Gets workspaces in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- workspaces in a resource group 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) Gets 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:
- workspaces in a resource group 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters) Create or update a workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.parameters
- The parameters required to create or update a workspace.- Returns:
- the
SyncPoller
for polling of the top level Workspace resource container. - 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 parameters, com.azure.core.util.Context context) Create or update a workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.parameters
- The parameters required to create or update a workspace.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of the top level Workspace resource container. - 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 parameters) Create or update a workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.parameters
- The parameters required to create or update a workspace.- Returns:
- the top level Workspace resource container.
- 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 parameters, com.azure.core.util.Context context) Create or update a workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.parameters
- The parameters required to create or update a workspace.context
- The context to associate with this operation.- Returns:
- the top level Workspace resource container.
- 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, Boolean force) Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.- 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, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.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
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.- 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
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the 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.
-
delete
void delete(String resourceGroupName, String workspaceName, Boolean force, com.azure.core.util.Context context) Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.force
- Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.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.
-
getByResourceGroup
Gets a workspace instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Returns:
- a workspace instance.
- 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 instance.- 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 instance 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.
-
update
Updates a workspace.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.parameters
- The parameters required to patch a workspace.- Returns:
- the top level Workspace resource container.
- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<WorkspaceInner> updateWithResponse(String resourceGroupName, String workspaceName, WorkspacePatch parameters, 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.parameters
- The parameters required to patch a workspace.context
- The context to associate with this operation.- Returns:
- the top level Workspace resource container 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.
-