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

The following fields are returned by SELECT queries:

get

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.
autoPause	object	Auto-pausing properties.
autoScale	object	Auto-scaling properties.
cacheSize	integer	The cache size.
creationDate	string (date-time)	The time when the Big Data pool was created.
customLibraries	array	List of custom libraries/packages associated with the spark pool.
defaultSparkLogFolder	string	The default folder where Spark logs will be written.
dynamicExecutorAllocation	object	Dynamic Executor Allocation.
isAutotuneEnabled	boolean	Whether autotune is required or not.
isComputeIsolationEnabled	boolean	Whether compute isolation is required or not.
lastSucceededTimestamp	string (date-time)	The time when the Big Data pool was updated successfully.
libraryRequirements	object	Library version requirements.
location	string	The geo-location where the resource lives. Required.
nodeCount	integer	The number of nodes in the Big Data pool.
nodeSize	string	The level of compute power that each node in the Big Data pool has. Known values are: "None", "Small", "Medium", "Large", "XLarge", "XXLarge", and "XXXLarge".
nodeSizeFamily	string	The kind of nodes that the Big Data pool provides. Known values are: "None", "MemoryOptimized", "HardwareAcceleratedFPGA", and "HardwareAcceleratedGPU".
provisioningState	string	The state of the Big Data pool.
sessionLevelPackagesEnabled	boolean	Whether session level packages enabled.
sparkConfigProperties	object	Spark configuration file to specify additional properties.
sparkEventsFolder	string	The Spark events folder.
sparkVersion	string	The Apache Spark version.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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.
autoPause	object	Auto-pausing properties.
autoScale	object	Auto-scaling properties.
cacheSize	integer	The cache size.
creationDate	string (date-time)	The time when the Big Data pool was created.
customLibraries	array	List of custom libraries/packages associated with the spark pool.
defaultSparkLogFolder	string	The default folder where Spark logs will be written.
dynamicExecutorAllocation	object	Dynamic Executor Allocation.
isAutotuneEnabled	boolean	Whether autotune is required or not.
isComputeIsolationEnabled	boolean	Whether compute isolation is required or not.
lastSucceededTimestamp	string (date-time)	The time when the Big Data pool was updated successfully.
libraryRequirements	object	Library version requirements.
location	string	The geo-location where the resource lives. Required.
nodeCount	integer	The number of nodes in the Big Data pool.
nodeSize	string	The level of compute power that each node in the Big Data pool has. Known values are: "None", "Small", "Medium", "Large", "XLarge", "XXLarge", and "XXXLarge".
nodeSizeFamily	string	The kind of nodes that the Big Data pool provides. Known values are: "None", "MemoryOptimized", "HardwareAcceleratedFPGA", and "HardwareAcceleratedGPU".
provisioningState	string	The state of the Big Data pool.
sessionLevelPackagesEnabled	boolean	Whether session level packages enabled.
sparkConfigProperties	object	Spark configuration file to specify additional properties.
sparkEventsFolder	string	The Spark events folder.
sparkVersion	string	The Apache Spark version.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, big_data_pool_name, subscription_id		Get Big Data pool. Get a Big Data pool.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List the Big Data pools in a workspace. List Big Data pools in a workspace.
create_or_update	insert	resource_group_name, workspace_name, big_data_pool_name, subscription_id, location	force	Create a Big Data pool. Create a new Big Data pool.
update	update	resource_group_name, workspace_name, big_data_pool_name, subscription_id		Update a Big Data pool. Patch a Big Data pool.
create_or_update	replace	resource_group_name, workspace_name, big_data_pool_name, subscription_id, location	force	Create a Big Data pool. Create a new Big Data pool.
delete	delete	resource_group_name, workspace_name, big_data_pool_name, subscription_id		Delete a Big Data pool. Delete a Big Data pool from 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
big_data_pool_name	string	Big Data pool name. Required.
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.
force	boolean	Whether to stop any running jobs in the Big Data pool. Default value is False.

SELECT examples

get

Get Big Data pool. Get a Big Data pool.

SELECT
id,
name,
autoPause,
autoScale,
cacheSize,
creationDate,
customLibraries,
defaultSparkLogFolder,
dynamicExecutorAllocation,
isAutotuneEnabled,
isComputeIsolationEnabled,
lastSucceededTimestamp,
libraryRequirements,
location,
nodeCount,
nodeSize,
nodeSizeFamily,
provisioningState,
sessionLevelPackagesEnabled,
sparkConfigProperties,
sparkEventsFolder,
sparkVersion,
tags,
type
FROM azure.synapse.big_data_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND big_data_pool_name = '{{ big_data_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

List the Big Data pools in a workspace. List Big Data pools in a workspace.

SELECT
id,
name,
autoPause,
autoScale,
cacheSize,
creationDate,
customLibraries,
defaultSparkLogFolder,
dynamicExecutorAllocation,
isAutotuneEnabled,
isComputeIsolationEnabled,
lastSucceededTimestamp,
libraryRequirements,
location,
nodeCount,
nodeSize,
nodeSizeFamily,
provisioningState,
sessionLevelPackagesEnabled,
sparkConfigProperties,
sparkEventsFolder,
sparkVersion,
tags,
type
FROM azure.synapse.big_data_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Big Data pool. Create a new Big Data pool.

INSERT INTO azure.synapse.big_data_pools (
tags,
location,
properties,
resource_group_name,
workspace_name,
big_data_pool_name,
subscription_id,
force
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ big_data_pool_name }}',
'{{ subscription_id }}',
'{{ force }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: big_data_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the big_data_pools resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the big_data_pools resource.
  - name: big_data_pool_name
    value: "{{ big_data_pool_name }}"
    description: Required parameter for the big_data_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the big_data_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      provisioningState: "{{ provisioningState }}"
      autoScale:
        minNodeCount: {{ minNodeCount }}
        enabled: {{ enabled }}
        maxNodeCount: {{ maxNodeCount }}
      autoPause:
        delayInMinutes: {{ delayInMinutes }}
        enabled: {{ enabled }}
      isComputeIsolationEnabled: {{ isComputeIsolationEnabled }}
      isAutotuneEnabled: {{ isAutotuneEnabled }}
      sessionLevelPackagesEnabled: {{ sessionLevelPackagesEnabled }}
      cacheSize: {{ cacheSize }}
      dynamicExecutorAllocation:
        enabled: {{ enabled }}
        minExecutors: {{ minExecutors }}
        maxExecutors: {{ maxExecutors }}
      sparkEventsFolder: "{{ sparkEventsFolder }}"
      nodeCount: {{ nodeCount }}
      libraryRequirements:
        time: "{{ time }}"
        content: "{{ content }}"
        filename: "{{ filename }}"
      customLibraries:
        - name: "{{ name }}"
          path: "{{ path }}"
          containerName: "{{ containerName }}"
          uploadedTimestamp: "{{ uploadedTimestamp }}"
          type: "{{ type }}"
          provisioningStatus: "{{ provisioningStatus }}"
          creatorId: "{{ creatorId }}"
      sparkConfigProperties:
        time: "{{ time }}"
        content: "{{ content }}"
        filename: "{{ filename }}"
        configurationType: "{{ configurationType }}"
      sparkVersion: "{{ sparkVersion }}"
      defaultSparkLogFolder: "{{ defaultSparkLogFolder }}"
      nodeSize: "{{ nodeSize }}"
      nodeSizeFamily: "{{ nodeSizeFamily }}"
  - name: force
    value: {{ force }}
    description: Whether to stop any running jobs in the Big Data pool. Default value is False.
    description: Whether to stop any running jobs in the Big Data pool. Default value is False.

UPDATE examples

update

Update a Big Data pool. Patch a Big Data pool.

UPDATE azure.synapse.big_data_pools
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND big_data_pool_name = '{{ big_data_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create a Big Data pool. Create a new Big Data pool.

REPLACE azure.synapse.big_data_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND big_data_pool_name = '{{ big_data_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND force = {{ force}}
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a Big Data pool. Delete a Big Data pool from the workspace.

DELETE FROM azure.synapse.big_data_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND big_data_pool_name = '{{ big_data_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;