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
location	string	The geo-location where the resource lives
properties	object	Big Data pool properties (title: Spark pool properties)
tags	object	Resource tags.

list_by_workspace

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Big Data pool properties (title: Spark pool properties)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, bigDataPoolName		Get a Big Data pool.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		List Big Data pools in a workspace.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, bigDataPoolName	force	Create a new Big Data pool.
update	update	subscriptionId, resourceGroupName, workspaceName, bigDataPoolName		Patch a Big Data pool.
delete	delete	subscriptionId, resourceGroupName, workspaceName, bigDataPoolName		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
bigDataPoolName	string	Big Data pool name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.
force	boolean	Whether to stop any running jobs in the Big Data pool

SELECT examples

get

Get a Big Data pool.

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

list_by_workspace

List Big Data pools in a workspace.

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

INSERT examples

create_or_update

Create a new Big Data pool.

INSERT INTO azure.synapse.big_data_pools (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
bigDataPoolName,
force
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ bigDataPoolName }}',
'{{ force }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: big_data_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the big_data_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the big_data_pools resource.
    - name: workspaceName
      value: string
      description: Required parameter for the big_data_pools resource.
    - name: bigDataPoolName
      value: string
      description: Required parameter for the big_data_pools resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Big Data pool properties
    - name: force
      value: boolean
      description: Whether to stop any running jobs in the Big Data pool

UPDATE examples

update

Patch a Big Data pool.

UPDATE azure.synapse.big_data_pools
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND bigDataPoolName = '{{ bigDataPoolName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Big Data pool from the workspace.

DELETE FROM azure.synapse.big_data_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND bigDataPoolName = '{{ bigDataPoolName }}' --required
;