workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.synapse.workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity of the workspace
location	string	The geo-location where the resource lives
properties	object	Workspace resource properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity of the workspace
location	string	The geo-location where the resource lives
properties	object	Workspace resource properties
tags	object	Resource tags.

list

Name	Datatype	Description
identity	object	Identity of the workspace
location	string	The geo-location where the resource lives
properties	object	Workspace resource properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName		Gets a workspace
list_by_resource_group	select	subscriptionId, resourceGroupName		Returns a list of workspaces in a resource group
list	select	subscriptionId		Returns a list of workspaces in a subscription
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName		Creates or updates a workspace
update	update	subscriptionId, resourceGroupName, workspaceName		Updates a workspace
delete	delete	subscriptionId, resourceGroupName, workspaceName		Deletes a 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	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a workspace

SELECT
identity,
location,
properties,
tags
FROM azure.synapse.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

Returns a list of workspaces in a resource group

SELECT
identity,
location,
properties,
tags
FROM azure.synapse.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Returns a list of workspaces in a subscription

SELECT
identity,
location,
properties,
tags
FROM azure.synapse.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace

INSERT INTO azure.synapse.workspaces (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
workspaceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Workspace resource properties
    - name: identity
      value: object
      description: |
        Identity of the workspace

UPDATE examples

update

Updates a workspace

UPDATE azure.synapse.workspaces
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes a workspace

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