big_data_pools

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

Overview

Name	big_data_pools
Type	Resource
Id	azure.synapse_artifacts.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}. # pylint: disable=line-too-long
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.
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" and "MemoryOptimized".
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.
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" and "MemoryOptimized".
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	big_data_pool_name, endpoint		Get Big Data Pool.
list	select	endpoint		List Big Data Pools.

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	The Big Data Pool name. Required.
endpoint	string	The service endpoint host (no scheme). (default: )

SELECT examples

get

Get Big Data Pool.

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

list

List Big Data Pools.

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