workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure_isv.databricks.workspaces

Fields

vw_workspaces

Name	Datatype	Description
access_connector	text	field from the properties object
authorizations	text	field from the properties object
created_by	text	field from the properties object
created_date_time	text	field from the properties object
default_catalog	text	field from the properties object
default_storage_firewall	text	field from the properties object
disk_encryption_set_id	text	field from the properties object
encryption	text	field from the properties object
enhanced_security_compliance	text	field from the properties object
is_uc_enabled	text	field from the properties object
location	text	The geo-location where the resource lives
managed_disk_identity	text	field from the properties object
managed_resource_group_id	text	field from the properties object
parameters	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
required_nsg_rules	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	SKU for the resource.
storage_account_identity	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
ui_definition_uri	text	field from the properties object
updated_by	text	field from the properties object
workspaceName	text	field from the properties object
workspace_id	text	field from the properties object
workspace_url	text	field from the properties object

workspaces

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The workspace properties.
sku	object	SKU for the resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName	Gets the workspace.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets all the workspaces within a resource group.
list_by_subscription	SELECT	subscriptionId	Gets all the workspaces within a subscription.
create_or_update	INSERT	resourceGroupName, subscriptionId, workspaceName, data__properties	Creates a new workspace.
delete	DELETE	resourceGroupName, subscriptionId, workspaceName	Deletes the workspace.
update	UPDATE	resourceGroupName, subscriptionId, workspaceName	Updates a workspace.

SELECT examples

Gets all the workspaces within a subscription.

vw_workspaces

SELECT
access_connector,
authorizations,
created_by,
created_date_time,
default_catalog,
default_storage_firewall,
disk_encryption_set_id,
encryption,
enhanced_security_compliance,
is_uc_enabled,
location,
managed_disk_identity,
managed_resource_group_id,
parameters,
private_endpoint_connections,
provisioning_state,
public_network_access,
required_nsg_rules,
resourceGroupName,
sku,
storage_account_identity,
subscriptionId,
system_data,
tags,
ui_definition_uri,
updated_by,
workspaceName,
workspace_id,
workspace_url
FROM azure_isv.databricks.vw_workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

workspaces

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure_isv.databricks.workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new workspaces resource.

All Properties

/*+ create */
INSERT INTO azure_isv.databricks.workspaces (
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
properties,
sku,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: managedResourceGroupId
          value: string
        - name: parameters
          value:
            - name: amlWorkspaceId
              value:
                - name: type
                  value: []
                - name: value
                  value: string
            - name: enableNoPublicIp
              value:
                - name: value
                  value: boolean
            - name: prepareEncryption
              value:
                - name: value
                  value: boolean
            - name: encryption
              value:
                - name: value
                  value:
                    - name: keySource
                      value: string
                    - name: KeyName
                      value: string
                    - name: keyversion
                      value: string
                    - name: keyvaulturi
                      value: string
            - name: resourceTags
              value:
                - name: value
                  value: object
        - name: provisioningState
          value: []
        - name: uiDefinitionUri
          value: string
        - name: authorizations
          value:
            - - name: principalId
                value: string
              - name: roleDefinitionId
                value: string
        - name: createdBy
          value:
            - name: oid
              value: string
            - name: puid
              value: string
            - name: applicationId
              value: string
        - name: createdDateTime
          value: []
        - name: workspaceId
          value: string
        - name: workspaceUrl
          value: string
        - name: storageAccountIdentity
          value:
            - name: principalId
              value: string
            - name: tenantId
              value: string
            - name: type
              value: string
        - name: diskEncryptionSetId
          value: string
        - name: encryption
          value:
            - name: entities
              value:
                - name: managedServices
                  value:
                    - name: keySource
                      value: string
                    - name: keyVaultProperties
                      value: string
                - name: managedDisk
                  value:
                    - name: keySource
                      value: string
                    - name: keyVaultProperties
                      value:
                        - name: keyVaultUri
                          value: string
                        - name: keyName
                          value: string
                        - name: keyVersion
                          value: string
                    - name: rotationToLatestKeyVersionEnabled
                      value: boolean
        - name: enhancedSecurityCompliance
          value:
            - name: automaticClusterUpdate
              value:
                - name: value
                  value: string
            - name: complianceSecurityProfile
              value:
                - name: complianceStandards
                  value:
                    - []
                - name: value
                  value: string
            - name: enhancedSecurityMonitoring
              value:
                - name: value
                  value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: groupIds
                    value:
                      - string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
        - name: publicNetworkAccess
          value: string
        - name: requiredNsgRules
          value: string
        - name: defaultCatalog
          value:
            - name: initialType
              value: string
            - name: initialName
              value: string
        - name: isUcEnabled
          value: boolean
        - name: accessConnector
          value:
            - name: id
              value: string
            - name: identityType
              value: string
            - name: userAssignedIdentityId
              value: string
        - name: defaultStorageFirewall
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a workspaces resource.

/*+ update */
UPDATE azure_isv.databricks.workspaces
SET 
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified workspaces resource.

/*+ delete */
DELETE FROM azure_isv.databricks.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';