Microsoft.Synapse workspaces 2021-06-01-preview

The workspaces resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Synapse/workspaces resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    connectivityEndpoints: {}
    cspWorkspaceAdminProperties: {
      initialWorkspaceAdminObjectId: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        kekIdentity: {
          userAssignedIdentity: 'string'
          useSystemAssignedIdentity: any()
        }
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [ 'string' ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    purviewConfiguration: {
      purviewResourceId: 'string'
    }
    sqlAdministratorLogin: 'string'
    sqlAdministratorLoginPassword: 'string'
    virtualNetworkProfile: {
      computeSubnetId: 'string'
    }
    workspaceRepositoryConfiguration: {
      accountName: 'string'
      collaborationBranch: 'string'
      hostName: 'string'
      lastCommitId: 'string'
      projectName: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      tenantId: 'string'
      type: 'string'
    }
  }
}

Property values

workspaces

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Synapse/workspaces'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-06-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity The workspace managed identity ManagedIdentity
properties Workspace properties WorkspaceProperties

ManagedIdentity

Name Description Value
type The type of managed identity for the workspace 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
userAssignedIdentities The User Assigned Managed Identities. object

WorkspaceProperties

Name Description Value
connectivityEndpoints Connectivity endpoints object
cspWorkspaceAdminProperties Initial workspace AAD admin properties for a CSP subscription CspWorkspaceAdminProperties
defaultDataLakeStorage Details of the data lake storage account associated with the workspace DataLakeStorageAccountDetails
encryption Details of the encryption associated with the workspace EncryptionDetails
managedResourceGroupName 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 '.' string
managedVirtualNetwork Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. string
managedVirtualNetworkSettings Managed Virtual Network Settings ManagedVirtualNetworkSettings
privateEndpointConnections Private endpoint connections to the workspace PrivateEndpointConnection[]
publicNetworkAccess Enable or Disable public network access to workspace 'Disabled'
'Enabled'
purviewConfiguration Purview Configuration PurviewConfiguration
sqlAdministratorLogin Login for workspace SQL active directory administrator string
sqlAdministratorLoginPassword SQL administrator login password string
virtualNetworkProfile Virtual Network Profile VirtualNetworkProfile
workspaceRepositoryConfiguration Git integration settings WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

Name Description Value
initialWorkspaceAdminObjectId AAD object ID of initial workspace admin string

DataLakeStorageAccountDetails

Name Description Value
accountUrl Account URL string
filesystem Filesystem name string

EncryptionDetails

Name Description Value
cmk Details of the customer managed key associated with the workspace CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name Description Value
kekIdentity Key encryption key properties KekIdentityProperties
key Details of the customer managed key associated with the workspace WorkspaceKeyDetails

KekIdentityProperties

Name Description Value
userAssignedIdentity User assigned identity resource Id string
useSystemAssignedIdentity Anything For Bicep, you can use the any() function.

WorkspaceKeyDetails

Name Description Value
keyVaultUrl Workspace Key sub-resource key vault url string
name Workspace Key sub-resource name string

ManagedVirtualNetworkSettings

Name Description Value
allowedAadTenantIdsForLinking Allowed Aad Tenant Ids For Linking string[]
linkedAccessCheckOnTargetResource Linked Access Check On Target Resource bool
preventDataExfiltration Prevent Data Exfiltration bool

PrivateEndpointConnection

Name Description Value
properties Properties of a private endpoint connection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Private endpoint details PrivateEndpoint
privateLinkServiceConnectionState Connection state details of the private endpoint PrivateLinkServiceConnectionState

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name Description Value
description The private link service connection description. string
status The private link service connection status. string

PurviewConfiguration

Name Description Value
purviewResourceId Purview Resource ID string

VirtualNetworkProfile

Name Description Value
computeSubnetId Subnet ID used for computes in workspace string

WorkspaceRepositoryConfiguration

Name Description Value
accountName Account name string
collaborationBranch Collaboration branch string
hostName GitHub Enterprise host name. For example: https://github.mydomain.com string
lastCommitId The last commit ID string
projectName VSTS project name string
repositoryName Repository name string
rootFolder Root folder to use in the repository string
tenantId The VSTS tenant ID string
type Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Synapse Proof-of-Concept

Deploy to Azure
This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools