Workspace interface

Package:
@azure/arm-databricks

Information about workspace.

Extends
TrackedResource

Properties

accessConnector

Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.
authorizations

The workspace provider authorizations.
computeMode

The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'
createdBy

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

Specifies the date and time when the workspace is created.
defaultCatalog

Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace.
defaultStorageFirewall

Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace.
diskEncryptionSetId

The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace.
encryption

Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
enhancedSecurityCompliance

Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace.
isUcEnabled

Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace.
managedDiskIdentity

The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace.
managedResourceGroupId

The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace.
parameters

The workspace's custom parameters.
privateEndpointConnections

Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
provisioningState

The workspace provisioning state.
publicNetworkAccess

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

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

The SKU of the resource.
storageAccountIdentity

The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace.
uiDefinitionUri

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

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

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

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

Inherited Properties

id

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

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

accessConnector

Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.

accessConnector?: WorkspacePropertiesAccessConnector

Property Value

WorkspacePropertiesAccessConnector

authorizations

The workspace provider authorizations.

authorizations?: WorkspaceProviderAuthorization[]

Property Value

WorkspaceProviderAuthorization[]

computeMode

The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'

computeMode: string

Property Value

string

createdBy

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

createdBy?: CreatedBy

Property Value

CreatedBy

createdDateTime

Specifies the date and time when the workspace is created.

createdDateTime?: Date

Property Value

Date

defaultCatalog

Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace.

defaultCatalog?: DefaultCatalogProperties

Property Value

DefaultCatalogProperties

defaultStorageFirewall

Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace.

defaultStorageFirewall?: string

Property Value

string

diskEncryptionSetId

The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace.

diskEncryptionSetId?: string

Property Value

string

encryption

Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.

encryption?: WorkspacePropertiesEncryption

Property Value

WorkspacePropertiesEncryption

enhancedSecurityCompliance

Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace.

enhancedSecurityCompliance?: EnhancedSecurityComplianceDefinition

Property Value

EnhancedSecurityComplianceDefinition

isUcEnabled

Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace.

isUcEnabled?: boolean

Property Value

boolean

managedDiskIdentity

The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace.

managedDiskIdentity?: ManagedIdentityConfiguration

Property Value

ManagedIdentityConfiguration

managedResourceGroupId

The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace.

managedResourceGroupId?: string

Property Value

string

parameters

The workspace's custom parameters.

parameters?: WorkspaceCustomParameters

Property Value

WorkspaceCustomParameters

privateEndpointConnections

Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The workspace provisioning state.

provisioningState?: string

Property Value

string

publicNetworkAccess

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.

publicNetworkAccess?: string

Property Value

string

requiredNsgRules

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

requiredNsgRules?: string

Property Value

string

sku

The SKU of the resource.

sku?: Sku

Property Value

Sku

storageAccountIdentity

The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace.

storageAccountIdentity?: ManagedIdentityConfiguration

Property Value

ManagedIdentityConfiguration

uiDefinitionUri

The blob URI where the UI definition file is located.

uiDefinitionUri?: string

Property Value

string

updatedBy

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

updatedBy?: CreatedBy

Property Value

CreatedBy

workspaceId

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

workspaceId?: string

Property Value

string

workspaceUrl

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

workspaceUrl?: string

Property Value

string

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type