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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
adlaResourceId	string	The ADLA resource ID.
azureADOnlyAuthentication	boolean	Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
connectivityEndpoints	object	Connectivity endpoints.
cspWorkspaceAdminProperties	object	Initial workspace AAD admin properties for a CSP subscription.
defaultDataLakeStorage	object	Workspace default data lake storage account details.
encryption	object	The encryption details of the workspace.
extraProperties	object	Workspace level configs and feature flags.
identity	object	Identity of the workspace.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupName	string	Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'.
managedVirtualNetwork	string	Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
managedVirtualNetworkSettings	object	Managed Virtual Network Settings.
privateEndpointConnections	array	Private endpoint connections to the workspace.
provisioningState	string	Resource provisioning state.
publicNetworkAccess	string	Enable or Disable public network access to workspace. Known values are: "Enabled" and "Disabled".
purviewConfiguration	object	Purview Configuration.
settings	object	Workspace settings.
sqlAdministratorLogin	string	Login for workspace SQL active directory administrator.
sqlAdministratorLoginPassword	string	SQL administrator login password.
tags	object	Resource tags.
trustedServiceBypassEnabled	boolean	Is trustedServiceBypassEnabled for the workspace.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkProfile	object	Virtual Network profile.
workspaceRepositoryConfiguration	object	Git integration settings.
workspaceUID	string	The workspace unique identifier.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
adlaResourceId	string	The ADLA resource ID.
azureADOnlyAuthentication	boolean	Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
connectivityEndpoints	object	Connectivity endpoints.
cspWorkspaceAdminProperties	object	Initial workspace AAD admin properties for a CSP subscription.
defaultDataLakeStorage	object	Workspace default data lake storage account details.
encryption	object	The encryption details of the workspace.
extraProperties	object	Workspace level configs and feature flags.
identity	object	Identity of the workspace.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupName	string	Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'.
managedVirtualNetwork	string	Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
managedVirtualNetworkSettings	object	Managed Virtual Network Settings.
privateEndpointConnections	array	Private endpoint connections to the workspace.
provisioningState	string	Resource provisioning state.
publicNetworkAccess	string	Enable or Disable public network access to workspace. Known values are: "Enabled" and "Disabled".
purviewConfiguration	object	Purview Configuration.
settings	object	Workspace settings.
sqlAdministratorLogin	string	Login for workspace SQL active directory administrator.
sqlAdministratorLoginPassword	string	SQL administrator login password.
tags	object	Resource tags.
trustedServiceBypassEnabled	boolean	Is trustedServiceBypassEnabled for the workspace.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkProfile	object	Virtual Network profile.
workspaceRepositoryConfiguration	object	Git integration settings.
workspaceUID	string	The workspace unique identifier.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
adlaResourceId	string	The ADLA resource ID.
azureADOnlyAuthentication	boolean	Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
connectivityEndpoints	object	Connectivity endpoints.
cspWorkspaceAdminProperties	object	Initial workspace AAD admin properties for a CSP subscription.
defaultDataLakeStorage	object	Workspace default data lake storage account details.
encryption	object	The encryption details of the workspace.
extraProperties	object	Workspace level configs and feature flags.
identity	object	Identity of the workspace.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupName	string	Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'.
managedVirtualNetwork	string	Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
managedVirtualNetworkSettings	object	Managed Virtual Network Settings.
privateEndpointConnections	array	Private endpoint connections to the workspace.
provisioningState	string	Resource provisioning state.
publicNetworkAccess	string	Enable or Disable public network access to workspace. Known values are: "Enabled" and "Disabled".
purviewConfiguration	object	Purview Configuration.
settings	object	Workspace settings.
sqlAdministratorLogin	string	Login for workspace SQL active directory administrator.
sqlAdministratorLoginPassword	string	SQL administrator login password.
tags	object	Resource tags.
trustedServiceBypassEnabled	boolean	Is trustedServiceBypassEnabled for the workspace.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkProfile	object	Virtual Network profile.
workspaceRepositoryConfiguration	object	Git integration settings.
workspaceUID	string	The workspace unique identifier.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Gets a workspace.
list_by_resource_group	select	resource_group_name, subscription_id		Returns a list of workspaces in a resource group.
list	select	subscription_id		Returns a list of workspaces in a subscription.
create_or_update	insert	resource_group_name, workspace_name, subscription_id, location		Creates or updates a workspace.
update	update	resource_group_name, workspace_name, subscription_id		Updates a workspace.
create_or_update	replace	resource_group_name, workspace_name, subscription_id, location		Creates or updates a workspace.
delete	delete	resource_group_name, workspace_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a workspace.

SELECT
id,
name,
adlaResourceId,
azureADOnlyAuthentication,
connectivityEndpoints,
cspWorkspaceAdminProperties,
defaultDataLakeStorage,
encryption,
extraProperties,
identity,
location,
managedResourceGroupName,
managedVirtualNetwork,
managedVirtualNetworkSettings,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
settings,
sqlAdministratorLogin,
sqlAdministratorLoginPassword,
tags,
trustedServiceBypassEnabled,
type,
virtualNetworkProfile,
workspaceRepositoryConfiguration,
workspaceUID
FROM azure.synapse.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns a list of workspaces in a resource group.

SELECT
id,
name,
adlaResourceId,
azureADOnlyAuthentication,
connectivityEndpoints,
cspWorkspaceAdminProperties,
defaultDataLakeStorage,
encryption,
extraProperties,
identity,
location,
managedResourceGroupName,
managedVirtualNetwork,
managedVirtualNetworkSettings,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
settings,
sqlAdministratorLogin,
sqlAdministratorLoginPassword,
tags,
trustedServiceBypassEnabled,
type,
virtualNetworkProfile,
workspaceRepositoryConfiguration,
workspaceUID
FROM azure.synapse.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of workspaces in a subscription.

SELECT
id,
name,
adlaResourceId,
azureADOnlyAuthentication,
connectivityEndpoints,
cspWorkspaceAdminProperties,
defaultDataLakeStorage,
encryption,
extraProperties,
identity,
location,
managedResourceGroupName,
managedVirtualNetwork,
managedVirtualNetworkSettings,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
purviewConfiguration,
settings,
sqlAdministratorLogin,
sqlAdministratorLoginPassword,
tags,
trustedServiceBypassEnabled,
type,
virtualNetworkProfile,
workspaceRepositoryConfiguration,
workspaceUID
FROM azure.synapse.workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace.

INSERT INTO azure.synapse.workspaces (
tags,
location,
identity,
properties,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      Identity of the workspace.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      defaultDataLakeStorage:
        accountUrl: "{{ accountUrl }}"
        filesystem: "{{ filesystem }}"
        resourceId: "{{ resourceId }}"
        createManagedPrivateEndpoint: {{ createManagedPrivateEndpoint }}
      sqlAdministratorLoginPassword: "{{ sqlAdministratorLoginPassword }}"
      managedResourceGroupName: "{{ managedResourceGroupName }}"
      sqlAdministratorLogin: "{{ sqlAdministratorLogin }}"
      virtualNetworkProfile:
        computeSubnetId: "{{ computeSubnetId }}"
      connectivityEndpoints: "{{ connectivityEndpoints }}"
      managedVirtualNetwork: "{{ managedVirtualNetwork }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      encryption:
        doubleEncryptionEnabled: {{ doubleEncryptionEnabled }}
        cmk:
          status: "{{ status }}"
          key:
            name: "{{ name }}"
            keyVaultUrl: "{{ keyVaultUrl }}"
          kekIdentity:
            userAssignedIdentity: "{{ userAssignedIdentity }}"
            useSystemAssignedIdentity: "{{ useSystemAssignedIdentity }}"
      managedVirtualNetworkSettings:
        preventDataExfiltration: {{ preventDataExfiltration }}
        linkedAccessCheckOnTargetResource: {{ linkedAccessCheckOnTargetResource }}
        allowedAadTenantIdsForLinking:
          - "{{ allowedAadTenantIdsForLinking }}"
      workspaceRepositoryConfiguration:
        type: "{{ type }}"
        hostName: "{{ hostName }}"
        accountName: "{{ accountName }}"
        projectName: "{{ projectName }}"
        repositoryName: "{{ repositoryName }}"
        collaborationBranch: "{{ collaborationBranch }}"
        rootFolder: "{{ rootFolder }}"
        lastCommitId: "{{ lastCommitId }}"
        tenantId: "{{ tenantId }}"
      purviewConfiguration:
        purviewResourceId: "{{ purviewResourceId }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      cspWorkspaceAdminProperties:
        initialWorkspaceAdminObjectId: "{{ initialWorkspaceAdminObjectId }}"
      azureADOnlyAuthentication: {{ azureADOnlyAuthentication }}
      trustedServiceBypassEnabled: {{ trustedServiceBypassEnabled }}

UPDATE examples

update

Updates a workspace.

UPDATE azure.synapse.workspaces
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a workspace.

REPLACE azure.synapse.workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a workspace.

DELETE FROM azure.synapse.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;