Microsoft.Databricks workspaces 2018-04-01

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.Databricks/workspaces resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Databricks/workspaces@2018-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  properties: {
    authorizations: [
      {
        principalId: 'string'
        roleDefinitionId: 'string'
      }
    ]
    createdBy: {}
    managedResourceGroupId: 'string'
    parameters: {
      amlWorkspaceId: {
        value: 'string'
      }
      customPrivateSubnetName: {
        value: 'string'
      }
      customPublicSubnetName: {
        value: 'string'
      }
      customVirtualNetworkId: {
        value: 'string'
      }
      enableNoPublicIp: {
        value: bool
      }
      encryption: {
        value: {
          KeyName: 'string'
          keySource: 'string'
          keyvaulturi: 'string'
          keyversion: 'string'
        }
      }
      loadBalancerBackendPoolName: {
        value: 'string'
      }
      loadBalancerId: {
        value: 'string'
      }
      natGatewayName: {
        value: 'string'
      }
      prepareEncryption: {
        value: bool
      }
      publicIpName: {
        value: 'string'
      }
      requireInfrastructureEncryption: {
        value: bool
      }
      storageAccountName: {
        value: 'string'
      }
      storageAccountSkuName: {
        value: 'string'
      }
      vnetAddressPrefix: {
        value: 'string'
      }
    }
    storageAccountIdentity: {}
    uiDefinitionUri: 'string'
    updatedBy: {}
  }
}

Property values

workspaces

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2018-04-01'
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
sku SKU for the resource. Sku
properties The workspace properties. WorkspaceProperties (required)

WorkspaceProperties

Name Description Value
authorizations The workspace provider authorizations. WorkspaceProviderAuthorization[]
createdBy Provides details of the entity that created/updated the workspace. CreatedBy
managedResourceGroupId The managed resource group Id. string (required)
parameters Custom Parameters used for Cluster Creation. WorkspaceCustomParameters
storageAccountIdentity The Managed Identity details for storage account. ManagedIdentityConfiguration
uiDefinitionUri The blob URI where the UI definition file is located. string
updatedBy Provides details of the entity that created/updated the workspace. CreatedBy

WorkspaceProviderAuthorization

Name Description Value
principalId The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. string (required)
roleDefinitionId The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. string (required)

CreatedBy

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

WorkspaceCustomParameters

Name Description Value
amlWorkspaceId The Value. WorkspaceCustomStringParameter
customPrivateSubnetName The Value. WorkspaceCustomStringParameter
customPublicSubnetName The Value. WorkspaceCustomStringParameter
customVirtualNetworkId The Value. WorkspaceCustomStringParameter
enableNoPublicIp The value which should be used for this field. WorkspaceCustomBooleanParameter
encryption The object that contains details of encryption used on the workspace. WorkspaceEncryptionParameter
loadBalancerBackendPoolName The Value. WorkspaceCustomStringParameter
loadBalancerId The Value. WorkspaceCustomStringParameter
natGatewayName The Value. WorkspaceCustomStringParameter
prepareEncryption The value which should be used for this field. WorkspaceCustomBooleanParameter
publicIpName The Value. WorkspaceCustomStringParameter
requireInfrastructureEncryption The value which should be used for this field. WorkspaceCustomBooleanParameter
storageAccountName The Value. WorkspaceCustomStringParameter
storageAccountSkuName The Value. WorkspaceCustomStringParameter
vnetAddressPrefix The Value. WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

Name Description Value
value The value which should be used for this field. string (required)

WorkspaceCustomBooleanParameter

Name Description Value
value The value which should be used for this field. bool (required)

WorkspaceEncryptionParameter

Name Description Value
value The object that contains details of encryption used on the workspace. Encryption

Encryption

Name Description Value
KeyName The name of KeyVault key. string
keySource The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault 'Default'
'Microsoft.Keyvault'
keyvaulturi The Uri of KeyVault. string
keyversion The version of KeyVault key. string

ManagedIdentityConfiguration

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

Sku

Name Description Value
name The SKU name. string (required)
tier The SKU tier. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Databricks All-in-one Template for VNet Injection

Deploy to Azure
This template allows you to create a network security group, a virtual network and an Azure Databricks workspace with the virtual network.
AzureDatabricks Template for VNetInjection and Load Balancer

Deploy to Azure
This template allows you to create a a load balancer, network security group, a virtual network and an Azure Databricks workspace with the virtual network.
AzureDatabricks Template for VNet Injection with NAT Gateway

Deploy to Azure
This template allows you to create a NAT gateway, network security group, a virtual network and an Azure Databricks workspace with the virtual network.
Deploy an Azure Databricks Workspace

Deploy to Azure
This template allows you to create an Azure Databricks workspace.
Azure Databricks Workspace with custom Address Range

Deploy to Azure
This template allows you to create an Azure Databricks workspace with a custom virtual network address range.
Deploy an Azure Databricks Workspace and configure CMK

Deploy to Azure
This template allows you to create an Azure Databricks workspace and configure CMK.
Azure Databricks Workspace with VNet Injection

Deploy to Azure
This template allows you to create an Azure Databricks workspace with a custom virtual network.