Workspaces - Create Or Update

  • Reference
Service:
Databricks
API Version:
2023-02-01

Creates a new workspace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}?api-version=2023-02-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

The ID of the target subscription.
workspaceName
 path True

string

The name of the workspace.
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
location True

string

The geo-location where the resource lives
properties.managedResourceGroupId True

string

The managed resource group Id.
properties.authorizations

WorkspaceProviderAuthorization[]

The workspace provider authorizations.
properties.createdBy

CreatedBy

Indicates the Object ID, PUID and Application ID of entity that created the workspace.
properties.encryption

WorkspaceProperties.Encryption

Encryption properties for databricks workspace
properties.managedDiskIdentity

ManagedIdentityConfiguration

The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption
properties.parameters

WorkspaceCustomParameters

The workspace's custom parameters.
properties.publicNetworkAccess

PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
properties.requiredNsgRules

RequiredNsgRules

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.
properties.storageAccountIdentity

ManagedIdentityConfiguration

The details of Managed Identity of Storage Account
properties.uiDefinitionUri

string

The blob URI where the UI definition file is located.
properties.updatedBy

CreatedBy

Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
sku

Sku

The SKU of the resource.
tags

object

Resource tags.

Responses

Name Type Description
200 OK

Workspace

Created - Returns information about the workspace, including provisioning status.
201 Created

Workspace

Created - Returns information about the workspace, including provisioning status.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create a workspace which is ready for Customer-Managed Key (CMK) encryption
Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks
Create or update workspace
Create or update workspace with custom parameters
Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption
Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace
Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Create a workspace which is ready for Customer-Managed Key (CMK) encryption

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "prepareEncryption": {
        "value": true
      }
    }
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z"
  }
}

Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    }
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z"
  }
}

Create or update workspace

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG"
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z"
  }
}

Create or update workspace with custom parameters

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "customVirtualNetworkId": {
        "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "customPublicSubnetName": {
        "value": "myPublicSubnet"
      },
      "customPrivateSubnetName": {
        "value": "myPrivateSubnet"
      }
    }
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "myPrivateSubnet"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "myPublicSubnet"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z"
  }
}

Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "prepareEncryption": {
        "value": true
      },
      "encryption": {
        "value": {
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "KeyName": "myKeyName",
          "keyversion": "00000000000000000000000000000000"
        }
      }
    }
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      },
      "encryption": {
        "type": "Object",
        "value": {
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "KeyName": "myKeyName",
          "keyversion": "00000000000000000000000000000000"
        }
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    }
  }
}

Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "encryption": {
        "value": {
          "keySource": "Default"
        }
      }
    }
  },
  "location": "westus"
}

Sample Response

Status code:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      },
      "encryption": {
        "type": "Object",
        "value": {
          "keySource": "Default"
        }
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    }
  }
}

Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2023-02-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    }
  },
  "location": "westus",
  "tags": {
    "mytag1": "myvalue1"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "mytag1": "myvalue1"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
  }
}
Status code:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "mytag1": "myvalue1"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
  }
}

Definitions

Name Description
CreatedBy

Provides details of the entity that created/updated the workspace.
createdByType

The type of identity that created the resource.
CustomParameterType

The type of variable that this is
Encryption

The object that contains details of encryption used on the workspace.
EncryptionEntitiesDefinition

Encryption entities for databricks workspace resource.
EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
EncryptionV2

The object that contains details of encryption used on the workspace.
ErrorDetail

Error details.
ErrorInfo

The code and message for an error.
ErrorResponse

Error response.
KeySource

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault
KeyVaultProperties

Key Vault input properties for encryption.
ManagedDiskEncryption

The object that contains details of encryption used on the workspace.
ManagedIdentityConfiguration

The Managed Identity details for storage account.
PrivateEndpoint

The private endpoint property of a private endpoint connection
PrivateEndpointConnection

The private endpoint connection of a workspace
PrivateEndpointConnectionProperties

The properties of a private endpoint connection
PrivateEndpointConnectionProvisioningState

The current provisioning state.
PrivateLinkServiceConnectionState

The current state of a private endpoint connection
PrivateLinkServiceConnectionStatus

The status of a private endpoint connection
ProvisioningState

Provisioning status of the workspace.
PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
RequiredNsgRules

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.
Sku

SKU for the resource.
systemData

Metadata pertaining to creation and last modification of the resource.
Workspace

Information about workspace.
Workspace.WorkspaceProperties.Encryption

Encryption properties for databricks workspace
WorkspaceCustomBooleanParameter

The value which should be used for this field.
WorkspaceCustomObjectParameter

The value which should be used for this field.
WorkspaceCustomParameters

Custom Parameters used for Cluster Creation.
WorkspaceCustomStringParameter

The Value.
WorkspaceEncryptionParameter

The object that contains details of encryption used on the workspace.
WorkspaceProperties.Encryption

Encryption properties for databricks workspace
WorkspaceProviderAuthorization

The workspace provider authorization.

CreatedBy

Provides details of the entity that created/updated the workspace.

Name Type Description
applicationId

string

The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.
oid

string

The Object ID that created the workspace.
puid

string

The Personal Object ID corresponding to the object ID above

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomParameterType

The type of variable that this is

Name Type Description
Bool

string

Object

string

String

string

Encryption

The object that contains details of encryption used on the workspace.

Name Type Default Value Description
KeyName

string

The name of KeyVault key.
keySource

KeySource

Default

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault
keyvaulturi

string

The Uri of KeyVault.
keyversion

string

The version of KeyVault key.

EncryptionEntitiesDefinition

Encryption entities for databricks workspace resource.

Name Type Description
managedDisk

ManagedDiskEncryption

Encryption properties for the databricks managed disks.
managedServices

EncryptionV2

Encryption properties for the databricks managed services.

EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

Name Type Description
Microsoft.Keyvault

string

EncryptionV2

The object that contains details of encryption used on the workspace.

Name Type Description
keySource

EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
keyVaultProperties

KeyVaultProperties

Key Vault input properties for encryption.

ErrorDetail

Error details.

Name Type Description
code

string

The error's code.
message

string

A human readable error message.
target

string

Indicates which property in the request is responsible for the error.

ErrorInfo

The code and message for an error.

Name Type Description
code

string

A machine readable error code.
details

ErrorDetail[]

error details.
innererror

string

Inner error details if they exist.
message

string

A human readable error message.

ErrorResponse

Error response.

Name Type Description
error

ErrorInfo

The code and message for an error.
The error details.

KeySource

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault

Name Type Description
Default

string

Microsoft.Keyvault

string

KeyVaultProperties

Key Vault input properties for encryption.

Name Type Description
keyName

string

The name of KeyVault key.
keyVaultUri

string

The Uri of KeyVault.
keyVersion

string

The version of KeyVault key.

ManagedDiskEncryption

The object that contains details of encryption used on the workspace.

Name Type Description
keySource

EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
keyVaultProperties

KeyVaultProperties

Key Vault input properties for encryption.
rotationToLatestKeyVersionEnabled

boolean

Indicate whether the latest key version should be automatically used for Managed Disk Encryption.

ManagedIdentityConfiguration

The Managed Identity details for storage account.

Name Type Description
principalId

string

The objectId of the Managed Identity that is linked to the Managed Storage account.
tenantId

string

The tenant Id where the Managed Identity is created.
type

string

The type of Identity created. It can be either SystemAssigned or UserAssigned.

PrivateEndpoint

The private endpoint property of a private endpoint connection

Name Type Description
id

string

The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a workspace

Name Type Description
id

string

The resource identifier.
name

string

The resource name.
properties

PrivateEndpointConnectionProperties

The private endpoint connection properties.
type

string

The resource type.

PrivateEndpointConnectionProperties

The properties of a private endpoint connection

Name Type Description
groupIds

string[]

GroupIds from the private link service resource.
privateEndpoint

PrivateEndpoint

Private endpoint
Private endpoint
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Private link service service connection state
Private endpoint connection state
provisioningState

PrivateEndpointConnectionProvisioningState

Provisioning state of the private endpoint connection.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name Type Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

Name Type Description
actionsRequired

string

Actions required for a private endpoint connection
description

string

The description for the current state of a private endpoint connection
status

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningState

Provisioning status of the workspace.

Name Type Description
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

Ready

string

Running

string

Succeeded

string

Updating

string

PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

Name Type Description
Disabled

string

Enabled

string

RequiredNsgRules

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.

Name Type Description
AllRules

string

NoAzureDatabricksRules

string

NoAzureServiceRules

string

Sku

SKU for the resource.

Name Type Description
name

string

The SKU name.
tier

string

The SKU tier.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

Workspace

Information about workspace.

Name Type Description
id

string

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.authorizations

WorkspaceProviderAuthorization[]

The workspace provider authorizations.
properties.createdBy

CreatedBy

Indicates the Object ID, PUID and Application ID of entity that created the workspace.
properties.createdDateTime

string

Specifies the date and time when the workspace is created.
properties.diskEncryptionSetId

string

The resource Id of the managed disk encryption set.
properties.encryption

WorkspaceProperties.Encryption

Encryption properties for databricks workspace
properties.managedDiskIdentity

ManagedIdentityConfiguration

The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption
properties.managedResourceGroupId

string

The managed resource group Id.
properties.parameters

WorkspaceCustomParameters

The workspace's custom parameters.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Private endpoint connections created on the workspace
properties.provisioningState

ProvisioningState

The workspace provisioning state.
properties.publicNetworkAccess

PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
properties.requiredNsgRules

RequiredNsgRules

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.
properties.storageAccountIdentity

ManagedIdentityConfiguration

The details of Managed Identity of Storage Account
properties.uiDefinitionUri

string

The blob URI where the UI definition file is located.
properties.updatedBy

CreatedBy

Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
properties.workspaceId

string

The unique identifier of the databricks workspace in databricks control plane.
properties.workspaceUrl

string

The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'
sku

Sku

The SKU of the resource.
systemData

systemData

The system metadata relating to this resource
tags

object

Resource tags.
type

string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Workspace.WorkspaceProperties.Encryption

Encryption properties for databricks workspace

Name Type Description
entities

EncryptionEntitiesDefinition

Encryption entities definition for the workspace.

WorkspaceCustomBooleanParameter

The value which should be used for this field.

Name Type Description
type

CustomParameterType

The type of variable that this is
value

boolean

The value which should be used for this field.

WorkspaceCustomObjectParameter

The value which should be used for this field.

Name Type Description
type

CustomParameterType

The type of variable that this is
value

object

The value which should be used for this field.

WorkspaceCustomParameters

Custom Parameters used for Cluster Creation.

Name Type Description
amlWorkspaceId

WorkspaceCustomStringParameter

The ID of a Azure Machine Learning workspace to link with Databricks workspace
customPrivateSubnetName

WorkspaceCustomStringParameter

The name of the Private Subnet within the Virtual Network
customPublicSubnetName

WorkspaceCustomStringParameter

The name of a Public Subnet within the Virtual Network
customVirtualNetworkId

WorkspaceCustomStringParameter

The ID of a Virtual Network where this Databricks Cluster should be created
enableNoPublicIp

WorkspaceCustomBooleanParameter

Should the Public IP be Disabled?
encryption

WorkspaceEncryptionParameter

Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.
loadBalancerBackendPoolName

WorkspaceCustomStringParameter

Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP).
loadBalancerId

WorkspaceCustomStringParameter

Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace.
natGatewayName

WorkspaceCustomStringParameter

Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets.
prepareEncryption

WorkspaceCustomBooleanParameter

Prepare the workspace for encryption. Enables the Managed Identity for managed storage account.
publicIpName

WorkspaceCustomStringParameter

Name of the Public IP for No Public IP workspace with managed vNet.
requireInfrastructureEncryption

WorkspaceCustomBooleanParameter

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.
resourceTags

WorkspaceCustomObjectParameter

Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level.
storageAccountName

WorkspaceCustomStringParameter

Default DBFS storage account name.
storageAccountSkuName

WorkspaceCustomStringParameter

Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs.
vnetAddressPrefix

WorkspaceCustomStringParameter

Address prefix for Managed virtual network. Default value for this input is 10.139.

WorkspaceCustomStringParameter

The Value.

Name Type Description
type

CustomParameterType

The type of variable that this is
value

string

The value which should be used for this field.

WorkspaceEncryptionParameter

The object that contains details of encryption used on the workspace.

Name Type Description
type

CustomParameterType

The type of variable that this is
value

Encryption

The value which should be used for this field.

WorkspaceProperties.Encryption

Encryption properties for databricks workspace

Name Type Description
entities

EncryptionEntitiesDefinition

Encryption entities definition for the workspace.

WorkspaceProviderAuthorization

The workspace provider authorization.

Name Type Description
principalId

string

The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources.
roleDefinitionId

string

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.