workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure_isv.databricks.workspaces

Fields

The following fields are returned by SELECT queries:

get

OK - Returns the workspace.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The workspace properties.
sku	object	The resource model definition representing SKU
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

list_by_resource_group

OK - Returns an array of workspaces.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The workspace properties.
sku	object	The resource model definition representing SKU
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

list_by_subscription

OK - Returns an array of workspaces.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The workspace properties.
sku	object	The resource model definition representing SKU
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, workspaceName, subscriptionId		Gets the workspace.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the workspaces within a resource group.
list_by_subscription	select	subscriptionId		Gets all the workspaces within a subscription.
create_or_update	insert	resourceGroupName, workspaceName, subscriptionId, data__properties		Creates a new workspace.
update	update	resourceGroupName, workspaceName, subscriptionId		Updates a workspace.
delete	delete	resourceGroupName, workspaceName, subscriptionId	forceDeletion	Deletes the 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. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the workspace.
forceDeletion	boolean	Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace.

SELECT examples

get

Gets the workspace.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure_isv.databricks.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets all the workspaces within a resource group.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure_isv.databricks.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Gets all the workspaces within a subscription.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure_isv.databricks.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a new workspace.

INSERT INTO azure_isv.databricks.workspaces (
data__properties,
data__sku,
data__tags,
data__location,
resourceGroupName,
workspaceName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        The workspace properties.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a workspace.

UPDATE azure_isv.databricks.workspaces
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes the workspace.

DELETE FROM azure_isv.databricks.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND forceDeletion = '{{ forceDeletion }}'
;