Workspaces - Create Or Update

Creates a new workspace.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The ID of the target subscription.

resourceGroupName
path True
  • string

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

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

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

The workspace provider authorizations.

properties.managedResourceGroupId True
  • string

The managed resource group Id.

properties.parameters
  • object

Name and value pairs that define the workspace parameters.

properties.uiDefinitionUri
  • string

The blob URI where the UI definition file is located.

sku

The SKU of the resource.

tags
  • object

Resource tags.

Responses

Name Type Description
200 OK

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

201 Created

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

Other Status Codes

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 or update workspace

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2018-04-01
{
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG"
  },
  "name": "myWorkspace",
  "location": "westus"
}

Sample Response

{
  "name": "myWorkspace",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "skuName"
  },
  "properties": {
    "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Created",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json"
  }
}

Definitions

ErrorDetail

Error details.

ErrorInfo

The code and message for an error.

ErrorResponse

Error response.

ProvisioningState

Provisioning status of the workspace.

Sku

SKU for the resource.

Workspace

Information about workspace.

WorkspaceProviderAuthorization

The workspace provider authorization.

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

error details.

innererror
  • string

Inner error details if they exist.

message
  • string

A human readable error message.

ErrorResponse

Error response.

Name Type Description
error

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

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

Sku

SKU for the resource.

Name Type Description
name
  • string

The SKU name.

tier
  • string

The SKU tier.

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

The workspace provider authorizations.

properties.managedResourceGroupId
  • string

The managed resource group Id.

properties.parameters
  • object

Name and value pairs that define the workspace parameters.

properties.provisioningState

The workspace provisioning state.

properties.uiDefinitionUri
  • string

The blob URI where the UI definition file is located.

sku

The SKU of the resource.

tags
  • object

Resource tags.

type
  • string

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

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.