Microsoft.Databricks (preview:2025-10-01)

2025/12/12 • 5 updated methods

Workspaces_Get (updated)
Description :  Gets the workspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "parameters": [
              {
                "#name": "customVirtualNetworkId",
                "Description": {
                  "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPublicSubnetName",
                "Description": {
                  "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPrivateSubnetName",
                "Description": {
                  "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
              "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_CreateOrUpdate (updated)
Description :  Creates a new workspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "parameters": [
              {
                "#name": "customVirtualNetworkId",
                "Description": {
                  "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPublicSubnetName",
                "Description": {
                  "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPrivateSubnetName",
                "Description": {
                  "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
              "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "parameters": [
              {
                "#name": "customVirtualNetworkId",
                "Description": {
                  "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPublicSubnetName",
                "Description": {
                  "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPrivateSubnetName",
                "Description": {
                  "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
              "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "parameters": [
              {
                "#name": "customVirtualNetworkId",
                "Description": {
                  "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPublicSubnetName",
                "Description": {
                  "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPrivateSubnetName",
                "Description": {
                  "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
              "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
parameters:
{
Description: Parameters supplied to the create or update a workspace. ,
Required: True ,
}
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_Update (updated)
Description :  Updates a workspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "parameters": [
              {
                "#name": "customVirtualNetworkId",
                "Description": {
                  "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPublicSubnetName",
                "Description": {
                  "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              },
              {
                "#name": "customPrivateSubnetName",
                "Description": {
                  "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                  "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
              "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
parameters:
{
Description: The update to the workspace. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
Workspaces_ListByResourceGroup (updated)
Description :  Gets all the workspaces within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "parameters": [
                  {
                    "#name": "customVirtualNetworkId",
                    "Description": {
                      "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  },
                  {
                    "#name": "customPublicSubnetName",
                    "Description": {
                      "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  },
                  {
                    "#name": "customPrivateSubnetName",
                    "Description": {
                      "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  }
                ]
              },
              {
                "#name": "publicNetworkAccess",
                "Description": {
                  "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
                  "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_ListBySubscription (updated)
Description :  Gets all the workspaces within a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "parameters": [
                  {
                    "#name": "customVirtualNetworkId",
                    "Description": {
                      "new": "The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The ID of a Virtual Network where this Databricks Cluster should be created. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  },
                  {
                    "#name": "customPublicSubnetName",
                    "Description": {
                      "new": "The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The name of a Public Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  },
                  {
                    "#name": "customPrivateSubnetName",
                    "Description": {
                      "new": "The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace.",
                      "old": "The name of the Private Subnet within the Virtual Network. Required in Hybrid ComputeMode. Not allowed in Serverless ComputeMode workspace."
                    }
                  }
                ]
              },
              {
                "#name": "publicNetworkAccess",
                "Description": {
                  "new": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.",
                  "old": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to config frontend Only private link for Serverless ComputeMode workspace."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
computeMode:
{
Description: The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' ,
Enum:
{
Serverless: No description available. ,
Hybrid: No description available. ,
}
,
Required: True ,
}
enum ,
managedResourceGroupId:
{
Description: The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace. ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: 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. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}