Share via

Workspace interface

  • Reference
Package:
@azure/arm-databricks

Information about workspace.

Extends
TrackedResource

Properties

authorizations

The workspace provider authorizations.
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. NOTE: This property will not be serialized. It can only be populated by the server.
diskEncryptionSetId

The resource Id of the managed disk encryption set. NOTE: This property will not be serialized. It can only be populated by the server.
encryption

Encryption properties for databricks workspace
managedDiskIdentity

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

The managed resource group Id.
parameters

The workspace's custom parameters.
privateEndpointConnections

Private endpoint connections created on the workspace NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The workspace provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

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

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

The SKU of the resource.
storageAccountIdentity

The details of Managed Identity of Storage Account
systemData

The system metadata relating to this resource NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
workspaceUrl

The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

authorizations

The workspace provider authorizations.

authorizations?: WorkspaceProviderAuthorization[]

Property Value

WorkspaceProviderAuthorization[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

createdDateTime?: Date

Property Value

Date

diskEncryptionSetId

The resource Id of the managed disk encryption set. NOTE: This property will not be serialized. It can only be populated by the server.

diskEncryptionSetId?: string

Property Value

string

encryption

Encryption properties for databricks workspace

encryption?: WorkspacePropertiesEncryption

Property Value

WorkspacePropertiesEncryption

managedDiskIdentity

The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption

managedDiskIdentity?: ManagedIdentityConfiguration

Property Value

ManagedIdentityConfiguration

managedResourceGroupId

The managed resource group Id.

managedResourceGroupId: string

Property Value

string

parameters

The workspace's custom parameters.

parameters?: WorkspaceCustomParameters

Property Value

WorkspaceCustomParameters

privateEndpointConnections

Private endpoint connections created on the workspace NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The workspace provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

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

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.

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

storageAccountIdentity?: ManagedIdentityConfiguration

Property Value

ManagedIdentityConfiguration

systemData

The system metadata relating to this resource NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

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. NOTE: This property will not be serialized. It can only be populated by the server.

workspaceId?: string

Property Value

string

workspaceUrl

The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' NOTE: This property will not be serialized. It can only be populated by the server.

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} NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type