workspaces

Creates, updates, deletes, gets or lists a workspaces resource.

Overview

Name	`workspaces`
Type	Resource
Id	`azure_isv.databricks.workspaces`

Fields

The following fields are returned by SELECT queries:

get
list_by_resource_group
list_by_subscription

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`accessConnector`	`object`	Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.
`authorizations`	`array`	The workspace provider authorizations.
`computeMode`	`string`	The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'. Required. Known values are: "Serverless" and "Hybrid". (Serverless, Hybrid)
`createdBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that created the workspace.
`createdDateTime`	`string (date-time)`	Specifies the date and time when the workspace is created.
`defaultCatalog`	`object`	Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace.
`defaultStorageFirewall`	`string`	Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
`diskEncryptionSetId`	`string`	The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace.
`encryption`	`object`	Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`enhancedSecurityCompliance`	`object`	Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace.
`isUcEnabled`	`boolean`	Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace.
`location`	`string`	The geo-location where the resource lives. Required.
`managedDiskIdentity`	`object`	The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace.
`managedResourceGroupId`	`string`	The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace.
`parameters`	`object`	The workspace's custom parameters.
`privateEndpointConnections`	`array`	Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`provisioningState`	`string`	The workspace provisioning state. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
`publicNetworkAccess`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`requiredNsgRules`	`string`	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. Known values are: "AllRules", "NoAzureDatabricksRules", and "NoAzureServiceRules". (AllRules, NoAzureDatabricksRules, NoAzureServiceRules)
`sku`	`object`	The SKU of the resource.
`storageAccountIdentity`	`object`	The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`uiDefinitionUri`	`string`	The blob URI where the UI definition file is located.
`updatedBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
`workspaceId`	`string`	The unique identifier of the databricks workspace in databricks control plane.
`workspaceUrl`	`string`	The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'.

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`accessConnector`	`object`	Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.
`authorizations`	`array`	The workspace provider authorizations.
`computeMode`	`string`	The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'. Required. Known values are: "Serverless" and "Hybrid". (Serverless, Hybrid)
`createdBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that created the workspace.
`createdDateTime`	`string (date-time)`	Specifies the date and time when the workspace is created.
`defaultCatalog`	`object`	Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace.
`defaultStorageFirewall`	`string`	Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
`diskEncryptionSetId`	`string`	The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace.
`encryption`	`object`	Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`enhancedSecurityCompliance`	`object`	Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace.
`isUcEnabled`	`boolean`	Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace.
`location`	`string`	The geo-location where the resource lives. Required.
`managedDiskIdentity`	`object`	The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace.
`managedResourceGroupId`	`string`	The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace.
`parameters`	`object`	The workspace's custom parameters.
`privateEndpointConnections`	`array`	Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`provisioningState`	`string`	The workspace provisioning state. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
`publicNetworkAccess`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`requiredNsgRules`	`string`	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. Known values are: "AllRules", "NoAzureDatabricksRules", and "NoAzureServiceRules". (AllRules, NoAzureDatabricksRules, NoAzureServiceRules)
`sku`	`object`	The SKU of the resource.
`storageAccountIdentity`	`object`	The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`uiDefinitionUri`	`string`	The blob URI where the UI definition file is located.
`updatedBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
`workspaceId`	`string`	The unique identifier of the databricks workspace in databricks control plane.
`workspaceUrl`	`string`	The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'.

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`accessConnector`	`object`	Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.
`authorizations`	`array`	The workspace provider authorizations.
`computeMode`	`string`	The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'. Required. Known values are: "Serverless" and "Hybrid". (Serverless, Hybrid)
`createdBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that created the workspace.
`createdDateTime`	`string (date-time)`	Specifies the date and time when the workspace is created.
`defaultCatalog`	`object`	Properties for Default Catalog configuration during workspace creation. Not allowed in Serverless ComputeMode workspace.
`defaultStorageFirewall`	`string`	Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
`diskEncryptionSetId`	`string`	The resource Id of the managed disk encryption set. Not allowed in Serverless ComputeMode workspace.
`encryption`	`object`	Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`enhancedSecurityCompliance`	`object`	Contains settings related to the Enhanced Security and Compliance Add-On. Supported in both Serverless and Hybrid ComputeMode workspace.
`isUcEnabled`	`boolean`	Indicates whether unity catalog enabled for the workspace or not. Set as true in Serverless ComputeMode workspace.
`location`	`string`	The geo-location where the resource lives. Required.
`managedDiskIdentity`	`object`	The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption. Only returned in Hybrid ComputeMode workspace.
`managedResourceGroupId`	`string`	The managed resource group Id. Required in Hybrid ComputeMode workspace. Not allowed in Serverless ComputeMode workspace.
`parameters`	`object`	The workspace's custom parameters.
`privateEndpointConnections`	`array`	Private endpoint connections created on the workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
`provisioningState`	`string`	The workspace provisioning state. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
`publicNetworkAccess`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`requiredNsgRules`	`string`	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. Known values are: "AllRules", "NoAzureDatabricksRules", and "NoAzureServiceRules". (AllRules, NoAzureDatabricksRules, NoAzureServiceRules)
`sku`	`object`	The SKU of the resource.
`storageAccountIdentity`	`object`	The details of Managed Identity of Storage Account. Only returned in Hybrid ComputeMode workspace.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`uiDefinitionUri`	`string`	The blob URI where the UI definition file is located.
`updatedBy`	`object`	Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
`workspaceId`	`string`	The unique identifier of the databricks workspace in databricks control plane.
`workspaceUrl`	`string`	The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`resource_group_name`, `workspace_name`, `subscription_id`		Gets the workspace.
`list_by_resource_group`	`select`	`resource_group_name`, `subscription_id`		Gets all the workspaces within a resource group.
`list_by_subscription`	`select`	`subscription_id`		Gets all the workspaces within a subscription.
`create_or_update`	`insert`	`resource_group_name`, `workspace_name`, `subscription_id`, `location`, `properties`		Creates a new workspace.
`update`	`update`	`resource_group_name`, `workspace_name`, `subscription_id`		Updates a workspace.
`create_or_update`	`replace`	`resource_group_name`, `workspace_name`, `subscription_id`, `location`, `properties`		Creates a new workspace.
`delete`	`delete`	`resource_group_name`, `workspace_name`, `subscription_id`	`forceDeletion`	Deletes the workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`subscription_id`	`string`
`workspace_name`	`string`	The name of the workspace. Required.
`forceDeletion`	`boolean`	Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace. Default value is False.

`SELECT` examples

get
list_by_resource_group
list_by_subscription

Gets the workspace.

SELECT
id,
name,
accessConnector,
authorizations,
computeMode,
createdBy,
createdDateTime,
defaultCatalog,
defaultStorageFirewall,
diskEncryptionSetId,
encryption,
enhancedSecurityCompliance,
isUcEnabled,
location,
managedDiskIdentity,
managedResourceGroupId,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
requiredNsgRules,
sku,
storageAccountIdentity,
systemData,
tags,
type,
uiDefinitionUri,
updatedBy,
workspaceId,
workspaceUrl
FROM azure_isv.databricks.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Gets all the workspaces within a resource group.

SELECT
id,
name,
accessConnector,
authorizations,
computeMode,
createdBy,
createdDateTime,
defaultCatalog,
defaultStorageFirewall,
diskEncryptionSetId,
encryption,
enhancedSecurityCompliance,
isUcEnabled,
location,
managedDiskIdentity,
managedResourceGroupId,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
requiredNsgRules,
sku,
storageAccountIdentity,
systemData,
tags,
type,
uiDefinitionUri,
updatedBy,
workspaceId,
workspaceUrl
FROM azure_isv.databricks.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Gets all the workspaces within a subscription.

SELECT
id,
name,
accessConnector,
authorizations,
computeMode,
createdBy,
createdDateTime,
defaultCatalog,
defaultStorageFirewall,
diskEncryptionSetId,
encryption,
enhancedSecurityCompliance,
isUcEnabled,
location,
managedDiskIdentity,
managedResourceGroupId,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
requiredNsgRules,
sku,
storageAccountIdentity,
systemData,
tags,
type,
uiDefinitionUri,
updatedBy,
workspaceId,
workspaceUrl
FROM azure_isv.databricks.workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create_or_update
Manifest

Creates a new workspace.

INSERT INTO azure_isv.databricks.workspaces (
tags,
location,
properties,
sku,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The workspace properties. Required.
    value:
      computeMode: "{{ computeMode }}"
      managedResourceGroupId: "{{ managedResourceGroupId }}"
      parameters:
        amlWorkspaceId:
          type: "{{ type }}"
          value: "{{ value }}"
        customVirtualNetworkId:
          type: "{{ type }}"
          value: "{{ value }}"
        customPublicSubnetName:
          type: "{{ type }}"
          value: "{{ value }}"
        customPrivateSubnetName:
          type: "{{ type }}"
          value: "{{ value }}"
        enableNoPublicIp:
          type: "{{ type }}"
          value: {{ value }}
        loadBalancerBackendPoolName:
          type: "{{ type }}"
          value: "{{ value }}"
        loadBalancerId:
          type: "{{ type }}"
          value: "{{ value }}"
        natGatewayName:
          type: "{{ type }}"
          value: "{{ value }}"
        publicIpName:
          type: "{{ type }}"
          value: "{{ value }}"
        prepareEncryption:
          type: "{{ type }}"
          value: {{ value }}
        encryption:
          type: "{{ type }}"
          value:
            keySource: "{{ keySource }}"
            KeyName: "{{ KeyName }}"
            keyversion: "{{ keyversion }}"
            keyvaulturi: "{{ keyvaulturi }}"
        requireInfrastructureEncryption:
          type: "{{ type }}"
          value: {{ value }}
        storageAccountName:
          type: "{{ type }}"
          value: "{{ value }}"
        storageAccountSkuName:
          type: "{{ type }}"
          value: "{{ value }}"
        vnetAddressPrefix:
          type: "{{ type }}"
          value: "{{ value }}"
        resourceTags:
          type: "{{ type }}"
          value: "{{ value }}"
      provisioningState: "{{ provisioningState }}"
      uiDefinitionUri: "{{ uiDefinitionUri }}"
      authorizations:
        - principalId: "{{ principalId }}"
          roleDefinitionId: "{{ roleDefinitionId }}"
      createdBy:
        oid: "{{ oid }}"
        puid: "{{ puid }}"
        applicationId: "{{ applicationId }}"
      updatedBy:
        oid: "{{ oid }}"
        puid: "{{ puid }}"
        applicationId: "{{ applicationId }}"
      createdDateTime: "{{ createdDateTime }}"
      workspaceId: "{{ workspaceId }}"
      workspaceUrl: "{{ workspaceUrl }}"
      storageAccountIdentity:
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        type: "{{ type }}"
      managedDiskIdentity:
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        type: "{{ type }}"
      diskEncryptionSetId: "{{ diskEncryptionSetId }}"
      encryption:
        entities:
          managedServices:
            keySource: "{{ keySource }}"
            keyVaultProperties:
              keyVaultUri: "{{ keyVaultUri }}"
              keyName: "{{ keyName }}"
              keyVersion: "{{ keyVersion }}"
          managedDisk:
            keySource: "{{ keySource }}"
            keyVaultProperties:
              keyVaultUri: "{{ keyVaultUri }}"
              keyName: "{{ keyName }}"
              keyVersion: "{{ keyVersion }}"
            rotationToLatestKeyVersionEnabled: {{ rotationToLatestKeyVersionEnabled }}
      enhancedSecurityCompliance:
        automaticClusterUpdate:
          value: "{{ value }}"
        complianceSecurityProfile:
          complianceStandards:
            - "{{ complianceStandards }}"
          value: "{{ value }}"
        enhancedSecurityMonitoring:
          value: "{{ value }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            groupIds:
              - "{{ groupIds }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      requiredNsgRules: "{{ requiredNsgRules }}"
      defaultCatalog:
        initialType: "{{ initialType }}"
        initialName: "{{ initialName }}"
      isUcEnabled: {{ isUcEnabled }}
      accessConnector:
        id: "{{ id }}"
        identityType: "{{ identityType }}"
        userAssignedIdentityId: "{{ userAssignedIdentityId }}"
      defaultStorageFirewall: "{{ defaultStorageFirewall }}"
  - name: sku
    description: |
      The SKU of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

`UPDATE` examples

update

Updates a workspace.

UPDATE azure_isv.databricks.workspaces
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

`REPLACE` examples

create_or_update

Creates a new workspace.

REPLACE azure_isv.databricks.workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

`DELETE` examples

delete

Deletes the workspace.

DELETE FROM azure_isv.databricks.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND forceDeletion = '{{ forceDeletion }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​