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": {},
    "uiDefinitionUri": "string",
    "authorizations": [
      {
        "principalId": "string",
        "roleDefinitionId": "string"
      }
    ]
  },
  "sku": {
    "name": "string",
    "tier": "string"
  }
}

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

WorkspaceProperties object

Name Type Required Value
managedResourceGroupId string Yes The managed resource group Id.
parameters object No Name and value pairs that define the workspace parameters.
uiDefinitionUri string No The blob URI where the UI definition file is located.
authorizations array No The workspace provider authorizations. - WorkspaceProviderAuthorization object

Sku object

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

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

Quickstart templates

The following quickstart templates deploy this resource type.