big_data_pools

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

Overview

Name	big_data_pools
Type	Resource
Id	azure.synapse.big_data_pools

Fields

vw_big_data_pools

Name	Datatype	Description
auto_pause	text	field from the properties object
auto_scale	text	field from the properties object
bigDataPoolName	text	field from the properties object
cache_size	text	field from the properties object
creation_date	text	field from the properties object
custom_libraries	text	field from the properties object
default_spark_log_folder	text	field from the properties object
dynamic_executor_allocation	text	field from the properties object
is_autotune_enabled	text	field from the properties object
is_compute_isolation_enabled	text	field from the properties object
last_succeeded_timestamp	text	field from the properties object
library_requirements	text	field from the properties object
location	text	The geo-location where the resource lives
node_count	text	field from the properties object
node_size	text	field from the properties object
node_size_family	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
session_level_packages_enabled	text	field from the properties object
spark_config_properties	text	field from the properties object
spark_events_folder	text	field from the properties object
spark_version	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
workspaceName	text	field from the properties object

big_data_pools

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a Big Data pool powered by Apache Spark
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	bigDataPoolName, resourceGroupName, subscriptionId, workspaceName	Get a Big Data pool.
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	List Big Data pools in a workspace.
create_or_update	INSERT	bigDataPoolName, resourceGroupName, subscriptionId, workspaceName	Create a new Big Data pool.
delete	DELETE	bigDataPoolName, resourceGroupName, subscriptionId, workspaceName	Delete a Big Data pool from the workspace.
update	UPDATE	bigDataPoolName, resourceGroupName, subscriptionId, workspaceName	Patch a Big Data pool.

SELECT examples

List Big Data pools in a workspace.

vw_big_data_pools

SELECT
auto_pause,
auto_scale,
bigDataPoolName,
cache_size,
creation_date,
custom_libraries,
default_spark_log_folder,
dynamic_executor_allocation,
is_autotune_enabled,
is_compute_isolation_enabled,
last_succeeded_timestamp,
library_requirements,
location,
node_count,
node_size,
node_size_family,
provisioning_state,
resourceGroupName,
session_level_packages_enabled,
spark_config_properties,
spark_events_folder,
spark_version,
subscriptionId,
tags,
workspaceName
FROM azure.synapse.vw_big_data_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

big_data_pools

SELECT
location,
properties,
tags
FROM azure.synapse.big_data_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.synapse.big_data_pools (
bigDataPoolName,
resourceGroupName,
subscriptionId,
workspaceName,
tags,
location,
properties
)
SELECT 
'{{ bigDataPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: autoScale
          value:
            - name: minNodeCount
              value: integer
            - name: enabled
              value: boolean
            - name: maxNodeCount
              value: integer
        - name: creationDate
          value: string
        - name: autoPause
          value:
            - name: delayInMinutes
              value: integer
            - name: enabled
              value: boolean
        - name: isComputeIsolationEnabled
          value: boolean
        - name: isAutotuneEnabled
          value: boolean
        - name: sessionLevelPackagesEnabled
          value: boolean
        - name: cacheSize
          value: integer
        - name: dynamicExecutorAllocation
          value:
            - name: enabled
              value: boolean
            - name: minExecutors
              value: integer
            - name: maxExecutors
              value: integer
        - name: sparkEventsFolder
          value: string
        - name: nodeCount
          value: integer
        - name: libraryRequirements
          value:
            - name: time
              value: string
            - name: content
              value: string
            - name: filename
              value: string
        - name: customLibraries
          value:
            - - name: name
                value: string
              - name: path
                value: string
              - name: containerName
                value: string
              - name: uploadedTimestamp
                value: string
              - name: type
                value: string
              - name: provisioningStatus
                value: string
              - name: creatorId
                value: string
        - name: sparkConfigProperties
          value:
            - name: time
              value: string
            - name: content
              value: string
            - name: filename
              value: string
            - name: configurationType
              value: string
        - name: sparkVersion
          value: string
        - name: defaultSparkLogFolder
          value: string
        - name: nodeSize
          value: string
        - name: nodeSizeFamily
          value: string
        - name: lastSucceededTimestamp
          value: string

UPDATE example

Updates a big_data_pools resource.

/*+ update */
UPDATE azure.synapse.big_data_pools
SET 
tags = '{{ tags }}'
WHERE 
bigDataPoolName = '{{ bigDataPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified big_data_pools resource.

/*+ delete */
DELETE FROM azure.synapse.big_data_pools
WHERE bigDataPoolName = '{{ bigDataPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';