workspaces

Creates, updates, deletes, gets or lists a workspaces resource.

Overview

Name	workspaces
Type	Resource
Id	azure_extras.healthcare.workspaces

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
properties	object	Workspaces resource specific properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_resource_group

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the resource group.

Name	Datatype	Description
properties	object	Workspaces resource specific properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_subscription

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the subscription.

Name	Datatype	Description
properties	object	Workspaces resource specific properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName		Gets the properties of the specified workspace.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the available workspaces under the specified resource group.
list_by_subscription	select	subscriptionId		Lists all the available workspaces under the specified subscription.
create_or_update	insert	resourceGroupName, subscriptionId, workspaceName		Creates or updates a workspace resource with the specified parameters.
update	update	resourceGroupName, subscriptionId, workspaceName		Patch workspace details.
delete	delete	subscriptionId, resourceGroupName, workspaceName		Deletes a specified workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group that contains the service instance.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of workspace resource.

SELECT examples

get

Gets the properties of the specified workspace.

SELECT
properties,
systemData
FROM azure_extras.healthcare.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

Lists all the available workspaces under the specified resource group.

SELECT
properties,
systemData
FROM azure_extras.healthcare.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all the available workspaces under the specified subscription.

SELECT
properties,
systemData
FROM azure_extras.healthcare.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace resource with the specified parameters.

INSERT INTO azure_extras.healthcare.workspaces (
data__properties,
resourceGroupName,
subscriptionId,
workspaceName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        Workspaces resource specific properties.

UPDATE examples

update

Patch workspace details.

UPDATE azure_extras.healthcare.workspaces
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes a specified workspace.

DELETE FROM azure_extras.healthcare.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
;