workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.synapse.workspaces

Fields

vw_workspaces

Name	Datatype	Description
adla_resource_id	text	field from the properties object
azure_ad_only_authentication	text	field from the properties object
connectivity_endpoints	text	field from the properties object
csp_workspace_admin_properties	text	field from the properties object
default_data_lake_storage	text	field from the properties object
encryption	text	field from the properties object
extra_properties	text	field from the properties object
identity	text	The workspace managed identity
location	text	The geo-location where the resource lives
managed_resource_group_name	text	field from the properties object
managed_virtual_network	text	field from the properties object
managed_virtual_network_settings	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
purview_configuration	text	field from the properties object
resourceGroupName	text	field from the properties object
settings	text	field from the properties object
sql_administrator_login	text	field from the properties object
sql_administrator_login_password	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
trusted_service_bypass_enabled	text	field from the properties object
virtual_network_profile	text	field from the properties object
workspaceName	text	field from the properties object
workspace_repository_configuration	text	field from the properties object
workspace_uid	text	field from the properties object

workspaces

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName	Gets a workspace
list	SELECT	subscriptionId	Returns a list of workspaces in a subscription
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns a list of workspaces in a resource group
create_or_update	INSERT	resourceGroupName, subscriptionId, workspaceName	Creates or updates a workspace
delete	DELETE	resourceGroupName, subscriptionId, workspaceName	Deletes a workspace
update	UPDATE	resourceGroupName, subscriptionId, workspaceName	Updates a workspace

SELECT examples

Returns a list of workspaces in a subscription

vw_workspaces

SELECT
adla_resource_id,
azure_ad_only_authentication,
connectivity_endpoints,
csp_workspace_admin_properties,
default_data_lake_storage,
encryption,
extra_properties,
identity,
location,
managed_resource_group_name,
managed_virtual_network,
managed_virtual_network_settings,
private_endpoint_connections,
provisioning_state,
public_network_access,
purview_configuration,
resourceGroupName,
settings,
sql_administrator_login,
sql_administrator_login_password,
subscriptionId,
tags,
trusted_service_bypass_enabled,
virtual_network_profile,
workspaceName,
workspace_repository_configuration,
workspace_uid
FROM azure.synapse.vw_workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

workspaces

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

INSERT example

Use the following StackQL query and manifest file to create a new workspaces resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.workspaces (
resourceGroupName,
subscriptionId,
workspaceName,
tags,
location,
properties,
identity
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: defaultDataLakeStorage
          value:
            - name: accountUrl
              value: string
            - name: filesystem
              value: string
            - name: resourceId
              value: string
            - name: createManagedPrivateEndpoint
              value: boolean
        - name: sqlAdministratorLoginPassword
          value: string
        - name: managedResourceGroupName
          value: string
        - name: provisioningState
          value: string
        - name: sqlAdministratorLogin
          value: string
        - name: virtualNetworkProfile
          value:
            - name: computeSubnetId
              value: string
        - name: connectivityEndpoints
          value: object
        - name: managedVirtualNetwork
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: string
        - name: encryption
          value:
            - name: doubleEncryptionEnabled
              value: boolean
            - name: cmk
              value:
                - name: status
                  value: string
                - name: key
                  value:
                    - name: name
                      value: string
                    - name: keyVaultUrl
                      value: string
                - name: kekIdentity
                  value:
                    - name: userAssignedIdentity
                      value: string
                    - name: useSystemAssignedIdentity
                      value: string
        - name: workspaceUID
          value: string
        - name: extraProperties
          value: object
        - name: managedVirtualNetworkSettings
          value:
            - name: preventDataExfiltration
              value: boolean
            - name: linkedAccessCheckOnTargetResource
              value: boolean
            - name: allowedAadTenantIdsForLinking
              value:
                - string
        - name: workspaceRepositoryConfiguration
          value:
            - name: type
              value: string
            - name: hostName
              value: string
            - name: accountName
              value: string
            - name: projectName
              value: string
            - name: repositoryName
              value: string
            - name: collaborationBranch
              value: string
            - name: rootFolder
              value: string
            - name: lastCommitId
              value: string
            - name: tenantId
              value: string
        - name: purviewConfiguration
          value:
            - name: purviewResourceId
              value: string
        - name: adlaResourceId
          value: string
        - name: publicNetworkAccess
          value: string
        - name: cspWorkspaceAdminProperties
          value:
            - name: initialWorkspaceAdminObjectId
              value: string
        - name: settings
          value: object
        - name: azureADOnlyAuthentication
          value: boolean
        - name: trustedServiceBypassEnabled
          value: boolean
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: []

UPDATE example

Updates a workspaces resource.

/*+ update */
UPDATE azure.synapse.workspaces
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified workspaces resource.

/*+ delete */
DELETE FROM azure.synapse.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';