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

The workspace provider authorizations.

properties.createdBy

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

properties.parameters

The workspace's custom parameters.

properties.storageAccountIdentity

The details of Managed Identity of Storage Account

properties.uiDefinitionUri
  • string

The blob URI where the UI definition file is located.

properties.updatedBy

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

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 a workspace which is ready for Customer-Managed Key (CMK) encryption
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

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=2018-04-01

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

Sample Response

{
  "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"
  }
}
{
  "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

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"
  },
  "location": "westus"
}

Sample Response

{
  "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"
  }
}
{
  "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=2018-04-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

{
  "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"
  }
}
{
  "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=2018-04-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

{
  "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"
  }
}
{
  "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=2018-04-01

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

Sample Response

{
  "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"
  }
}
{
  "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"
    }
  }
}

Definitions

CreatedBy

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

CustomParameterType

The type of variable that this is

Encryption

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

ManagedIdentityConfiguration

The Managed Identity details for storage account.

ProvisioningState

Provisioning status of the workspace.

Sku

SKU for the resource.

Workspace

Information about 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.

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

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

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.

KeySource

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

Name Type Description
Default
  • string
Microsoft.Keyvault
  • string

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.

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.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.managedResourceGroupId
  • string

The managed resource group Id.

properties.parameters

The workspace's custom parameters.

properties.provisioningState

The workspace provisioning state.

properties.storageAccountIdentity

The details of Managed Identity of Storage Account

properties.uiDefinitionUri
  • string

The blob URI where the UI definition file is located.

properties.updatedBy

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

The SKU of the resource.

tags
  • object

Resource tags.

type
  • string

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

WorkspaceCustomBooleanParameter

The value which should be used for this field.

Name Type Description
type

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

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

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

customPrivateSubnetName

The name of the Private Subnet within the Virtual Network

customPublicSubnetName

The name of a Public Subnet within the Virtual Network

customVirtualNetworkId

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

enableNoPublicIp

Should the Public IP be Disabled?

encryption

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

loadBalancerBackendPoolName

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

loadBalancerId

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

natGatewayName

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

prepareEncryption

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

publicIpName

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

requireInfrastructureEncryption

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

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

storageAccountName

Default DBFS storage account name.

storageAccountSkuName

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

vnetAddressPrefix

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

WorkspaceCustomStringParameter

The Value.

Name Type Description
type

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

The type of variable that this is

value

The value which should be used for this field.

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.