Microsoft.Databricks workspaces template reference

Template format

To create a Microsoft.Databricks/workspaces resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Databricks/workspaces",
  "apiVersion": "2018-04-01",
  "tags": {},
  "location": "string",
  "properties": {
    "managedResourceGroupId": "string",
    "parameters": {
      "amlWorkspaceId": {
        "type": "string",
        "value": "string"
      },
      "customVirtualNetworkId": {
        "type": "string",
        "value": "string"
      },
      "customPublicSubnetName": {
        "type": "string",
        "value": "string"
      },
      "customPrivateSubnetName": {
        "type": "string",
        "value": "string"
      },
      "enableNoPublicIp": {
        "type": "string",
        "value": "boolean"
      },
      "prepareEncryption": {
        "type": "string",
        "value": "boolean"
      },
      "encryption": {
        "type": "string",
        "value": {
          "keySource": "string",
          "KeyName": "string",
          "keyversion": "string",
          "keyvaulturi": "string"
        }
      },
      "requireInfrastructureEncryption": {
        "type": "string",
        "value": "boolean"
      }
    },
    "uiDefinitionUri": "string",
    "authorizations": [
      {
        "principalId": "string",
        "roleDefinitionId": "string"
      }
    ],
    "createdBy": {},
    "updatedBy": {},
    "storageAccountIdentity": {}
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Databricks/workspaces object

Name Type Required Value
name string Yes The name of the workspace.
type enum Yes Microsoft.Databricks/workspaces
apiVersion enum Yes 2018-04-01
tags object No Resource tags.
location string Yes The geo-location where the resource lives
properties object Yes The workspace properties. - WorkspaceProperties object
sku object No The SKU of the resource. - Sku object
resources array No virtualNetworkPeerings

WorkspaceProperties object

Name Type Required Value
managedResourceGroupId string Yes The managed resource group Id.
parameters object No The workspace's custom parameters. - WorkspaceCustomParameters object
uiDefinitionUri string No The blob URI where the UI definition file is located.
authorizations array No The workspace provider authorizations. - WorkspaceProviderAuthorization object
createdBy object No Indicates the Object ID, PUID and Application ID of entity that created the workspace. - CreatedBy object
updatedBy object No Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. - CreatedBy object
storageAccountIdentity object No The details of Managed Identity of Storage Account - ManagedIdentityConfiguration object

Sku object

Name Type Required Value
name string Yes The SKU name.
tier string No The SKU tier.

WorkspaceCustomParameters object

Name Type Required Value
amlWorkspaceId object No The ID of a Azure Machine Learning workspace to link with Databricks workspace - WorkspaceCustomStringParameter object
customVirtualNetworkId object No The ID of a Virtual Network where this Databricks Cluster should be created - WorkspaceCustomStringParameter object
customPublicSubnetName object No The name of a Public Subnet within the Virtual Network - WorkspaceCustomStringParameter object
customPrivateSubnetName object No The name of the Private Subnet within the Virtual Network - WorkspaceCustomStringParameter object
enableNoPublicIp object No Should the Public IP be Disabled? - WorkspaceCustomBooleanParameter object
prepareEncryption object No Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. - WorkspaceCustomBooleanParameter object
encryption object No Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. - WorkspaceEncryptionParameter object
requireInfrastructureEncryption object No A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. - WorkspaceCustomBooleanParameter object

WorkspaceProviderAuthorization object

Name Type Required Value
principalId string Yes The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. - globally unique identifier
roleDefinitionId string Yes 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. - globally unique identifier

WorkspaceCustomStringParameter object

Name Type Required Value
type enum No The type of variable that this is. - Bool, Object, String
value string Yes The value which should be used for this field.

WorkspaceCustomBooleanParameter object

Name Type Required Value
type enum No The type of variable that this is. - Bool, Object, String
value boolean Yes The value which should be used for this field.

WorkspaceEncryptionParameter object

Name Type Required Value
type enum No The type of variable that this is. - Bool, Object, String
value object No The value which should be used for this field. - Encryption object

Encryption object

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

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.
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.
Azure Databricks Workspace with VNet Injection

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