Big Data Pools - List

List Big Data Pools

GET {endpoint}/bigDataPools?api-version=2019-06-01-preview

URI Parameters

Name In Required Type Description
endpoint
path True
  • string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

api-version
query True
  • string

The Synapse client API Version.

Responses

Name Type Description
200 OK

Success response.

Other Status Codes

Error response describing why the operation failed.

Examples

List Big Data Pools

Sample Request

GET exampleWorkspace.dev.azuresynapse.net/bigDataPools?api-version=2019-06-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "creationDate": "2020-07-14T10:09:52.5133333Z",
        "sparkVersion": "2.4",
        "nodeCount": 3,
        "nodeSize": "Small",
        "nodeSizeFamily": "MemoryOptimized",
        "autoScale": {
          "enabled": true,
          "minNodeCount": 3,
          "maxNodeCount": 20
        },
        "autoPause": {
          "enabled": true,
          "delayInMinutes": 15
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1",
      "name": "pool1",
      "type": "Microsoft.Synapse/workspaces/sparkComputes",
      "location": "southeastasia",
      "tags": {}
    }
  ]
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitions

AutoPauseProperties

Spark pool auto-pausing properties

AutoScaleProperties

Spark pool auto-scaling properties

BigDataPoolResourceInfo

Big Data pool

BigDataPoolResourceInfoListResult

Collection of Big Data pools

DynamicExecutorAllocation

Dynamic Executor Allocation Properties

ErrorAdditionalInfo

The resource management error additional info.

ErrorContract

Error details.

ErrorResponse

Error Response

LibraryInfo

Information about a library/package created at the workspace level.

LibraryRequirements

Spark pool library version requirements

NodeSize

The level of compute power that each node in the Big Data pool has.

NodeSizeFamily

The kind of nodes that the Big Data pool provides.

AutoPauseProperties

Spark pool auto-pausing properties

Name Type Description
delayInMinutes
  • integer

Number of minutes of idle time before the Big Data pool is automatically paused.

enabled
  • boolean

Whether auto-pausing is enabled for the Big Data pool.

AutoScaleProperties

Spark pool auto-scaling properties

Name Type Description
enabled
  • boolean

Whether automatic scaling is enabled for the Big Data pool.

maxNodeCount
  • integer

The maximum number of nodes the Big Data pool can support.

minNodeCount
  • integer

The minimum number of nodes the Big Data pool can support.

BigDataPoolResourceInfo

Big Data pool

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

The geo-location where the resource lives

name
  • string

The name of the resource

properties.autoPause

Spark pool auto-pausing properties
Auto-pausing properties

properties.autoScale

Spark pool auto-scaling properties
Auto-scaling properties

properties.cacheSize
  • integer

The cache size

properties.creationDate
  • string

The time when the Big Data pool was created.

properties.customLibraries

List of custom libraries/packages associated with the spark pool.

properties.defaultSparkLogFolder
  • string

The default folder where Spark logs will be written.

properties.dynamicExecutorAllocation

Dynamic Executor Allocation

properties.isComputeIsolationEnabled
  • boolean

Whether compute isolation is required or not.

properties.lastSucceededTimestamp
  • string

The time when the Big Data pool was updated successfully.

properties.libraryRequirements

Spark pool library version requirements
Library version requirements

properties.nodeCount
  • integer

The number of nodes in the Big Data pool.

properties.nodeSize

The level of compute power that each node in the Big Data pool has.

properties.nodeSizeFamily

The kind of nodes that the Big Data pool provides.

properties.provisioningState
  • string

The state of the Big Data pool.

properties.sessionLevelPackagesEnabled
  • boolean

Whether session level packages enabled.

properties.sparkConfigProperties

Spark pool library version requirements
Spark configuration file to specify additional properties

properties.sparkEventsFolder
  • string

The Spark events folder

properties.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"

BigDataPoolResourceInfoListResult

Collection of Big Data pools

Name Type Description
nextLink
  • string

Link to the next page of results

value

List of Big Data pools

DynamicExecutorAllocation

Dynamic Executor Allocation Properties

Name Type Description
enabled
  • boolean

Indicates whether Dynamic Executor Allocation is enabled or not.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorContract

Error details.

Name Type Description
error

Error Response
The error details.

ErrorResponse

Error Response

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

LibraryInfo

Information about a library/package created at the workspace level.

Name Type Description
containerName
  • string

Storage blob container name.

creatorId
  • string

Creator Id of the library/package.

name
  • string

Name of the library.

path
  • string

Storage blob path of library.

provisioningStatus
  • string

Provisioning status of the library/package.

type
  • string

Type of the library.

uploadedTimestamp
  • string

The last update time of the library.

LibraryRequirements

Spark pool library version requirements

Name Type Description
content
  • string

The library requirements.

filename
  • string

The filename of the library requirements file.

time
  • string

The last update time of the library requirements file.

NodeSize

The level of compute power that each node in the Big Data pool has.

Name Type Description
Large
  • string
Medium
  • string
None
  • string
Small
  • string
XLarge
  • string
XXLarge
  • string
XXXLarge
  • string

NodeSizeFamily

The kind of nodes that the Big Data pool provides.

Name Type Description
MemoryOptimized
  • string
None
  • string