Workspaces interface
Interface representing a Workspaces.
Methods
Method Details
beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates or updates a workspace resource with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, workspace: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- workspace
- Workspace
The parameters for creating or updating a healthcare workspace.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates or updates a workspace resource with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, workspace: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- workspace
- Workspace
The parameters for creating or updating a healthcare workspace.
The options parameters.
Returns
Promise<Workspace>
beginDelete(string, string, WorkspacesDeleteOptionalParams)
Deletes a specified workspace.
function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)
Deletes a specified workspace.
function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, WorkspacePatchResource, WorkspacesUpdateOptionalParams)
Patch workspace details.
function beginUpdate(resourceGroupName: string, workspaceName: string, workspacePatchResource: WorkspacePatchResource, options?: WorkspacesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- workspacePatchResource
- WorkspacePatchResource
The parameters for updating a specified workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Workspace>, Workspace>>
beginUpdateAndWait(string, string, WorkspacePatchResource, WorkspacesUpdateOptionalParams)
Patch workspace details.
function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, workspacePatchResource: WorkspacePatchResource, options?: WorkspacesUpdateOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- workspacePatchResource
- WorkspacePatchResource
The parameters for updating a specified workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<Workspace>
get(string, string, WorkspacesGetOptionalParams)
Gets the properties of the specified workspace.
function get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- options
- WorkspacesGetOptionalParams
The options parameters.
Returns
Promise<Workspace>
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)
Lists all the available workspaces under the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
The options parameters.
Returns
listBySubscription(WorkspacesListBySubscriptionOptionalParams)
Lists all the available workspaces under the specified subscription.
function listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
The options parameters.