Big Data Pools - List By Workspace

Service:

Synapse

API Version:

2021-06-01-preview

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools?api-version=2021-06-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BigDataPoolResourceInfoListResult
Other Status Codes	ErrorResponse

Examples

List Big Data pools in a workspace

Sample Request

HTTP

GET https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools?api-version=2021-06-01-preview

Java

/** Samples for BigDataPools ListByWorkspace. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json
     */
    /**
     * Sample code: List Big Data pools in a workspace.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void listBigDataPoolsInAWorkspace(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .bigDataPools()
            .listByWorkspace("ExampleResourceGroup", "ExampleWorkspace", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python list_big_data_pools_in_workspace.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="01234567-89ab-4def-0123-456789abcdef",
    )

    response = client.big_data_pools.list_by_workspace(
        resource_group_name="ExampleResourceGroup",
        workspace_name="ExampleWorkspace",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json
func ExampleBigDataPoolsClient_NewListByWorkspacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBigDataPoolsClient().NewListByWorkspacePager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BigDataPoolResourceInfoListResult = armsynapse.BigDataPoolResourceInfoListResult{
		// 	Value: []*armsynapse.BigDataPoolResourceInfo{
		// 		{
		// 			Name: to.Ptr("ExamplePool"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armsynapse.BigDataPoolResourceProperties{
		// 				AutoPause: &armsynapse.AutoPauseProperties{
		// 					DelayInMinutes: to.Ptr[int32](15),
		// 					Enabled: to.Ptr(true),
		// 				},
		// 				AutoScale: &armsynapse.AutoScaleProperties{
		// 					Enabled: to.Ptr(true),
		// 					MaxNodeCount: to.Ptr[int32](50),
		// 					MinNodeCount: to.Ptr[int32](3),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				DefaultSparkLogFolder: to.Ptr("/logs"),
		// 				IsAutotuneEnabled: to.Ptr(false),
		// 				LibraryRequirements: &armsynapse.LibraryRequirements{
		// 					Content: to.Ptr(""),
		// 					Filename: to.Ptr("requirements.txt"),
		// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				},
		// 				NodeCount: to.Ptr[int32](4),
		// 				NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
		// 				NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SparkEventsFolder: to.Ptr("/events"),
		// 				SparkVersion: to.Ptr("3.3"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ExamplePool2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool2"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armsynapse.BigDataPoolResourceProperties{
		// 				AutoPause: &armsynapse.AutoPauseProperties{
		// 					DelayInMinutes: to.Ptr[int32](15),
		// 					Enabled: to.Ptr(true),
		// 				},
		// 				AutoScale: &armsynapse.AutoScaleProperties{
		// 					Enabled: to.Ptr(true),
		// 					MaxNodeCount: to.Ptr[int32](50),
		// 					MinNodeCount: to.Ptr[int32](3),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				DefaultSparkLogFolder: to.Ptr("/logs"),
		// 				IsAutotuneEnabled: to.Ptr(false),
		// 				LibraryRequirements: &armsynapse.LibraryRequirements{
		// 					Content: to.Ptr(""),
		// 					Filename: to.Ptr("requirements.txt"),
		// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				},
		// 				NodeCount: to.Ptr[int32](4),
		// 				NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
		// 				NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SparkEventsFolder: to.Ptr("/events"),
		// 				SparkVersion: to.Ptr("3.3"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List Big Data pools in a workspace.
 *
 * @summary List Big Data pools in a workspace.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json
 */
async function listBigDataPoolsInAWorkspace() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "01234567-89ab-4def-0123-456789abcdef";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "ExampleResourceGroup";
  const workspaceName = "ExampleWorkspace";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.bigDataPools.listByWorkspace(resourceGroupName, workspaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json
// this example is just showing the usage of "BigDataPools_ListByWorkspace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseWorkspaceResource created on azure
// for more information of creating SynapseWorkspaceResource, please refer to the document of SynapseWorkspaceResource
string subscriptionId = "01234567-89ab-4def-0123-456789abcdef";
string resourceGroupName = "ExampleResourceGroup";
string workspaceName = "ExampleWorkspace";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseBigDataPoolInfoResource
SynapseBigDataPoolInfoCollection collection = synapseWorkspace.GetSynapseBigDataPoolInfos();

// invoke the operation and iterate over the result
await foreach (SynapseBigDataPoolInfoResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SynapseBigDataPoolInfoData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool",
      "type": "Microsoft.Synapse/workspaces/bigDataPools",
      "location": "West US 2",
      "name": "ExamplePool",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "sparkVersion": "3.3",
        "nodeCount": 4,
        "nodeSize": "Medium",
        "nodeSizeFamily": "MemoryOptimized",
        "autoScale": {
          "enabled": true,
          "minNodeCount": 3,
          "maxNodeCount": 50
        },
        "autoPause": {
          "enabled": true,
          "delayInMinutes": 15
        },
        "creationDate": "1970-01-01T00:00:00Z",
        "sparkEventsFolder": "/events",
        "libraryRequirements": {
          "time": "1970-01-01T00:00:00Z",
          "content": "",
          "filename": "requirements.txt"
        },
        "defaultSparkLogFolder": "/logs",
        "isAutotuneEnabled": false
      }
    },
    {
      "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool2",
      "type": "Microsoft.Synapse/workspaces/bigDataPools",
      "location": "West US 2",
      "name": "ExamplePool2",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "sparkVersion": "3.3",
        "nodeCount": 4,
        "nodeSize": "Medium",
        "nodeSizeFamily": "MemoryOptimized",
        "autoScale": {
          "enabled": true,
          "minNodeCount": 3,
          "maxNodeCount": 50
        },
        "autoPause": {
          "enabled": true,
          "delayInMinutes": 15
        },
        "creationDate": "1970-01-01T00:00:00Z",
        "sparkEventsFolder": "/events",
        "libraryRequirements": {
          "time": "1970-01-01T00:00:00Z",
          "content": "",
          "filename": "requirements.txt"
        },
        "defaultSparkLogFolder": "/logs",
        "isAutotuneEnabled": false
      }
    }
  ],
  "nextLink": ""
}

Definitions

Name	Description
AutoPauseProperties	Spark pool auto-pausing properties
AutoScaleProperties	Spark pool auto-scaling properties
BigDataPoolResourceInfo	Big Data pool
BigDataPoolResourceInfoListResult	Collection of Big Data pools
ConfigurationType	The type of the spark config properties file.
DynamicExecutorAllocation	Dynamic Executor Allocation Properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
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.
SparkConfigProperties	Spark pool Config Properties

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	AutoPauseProperties	Spark pool auto-pausing properties Auto-pausing properties
properties.autoScale	AutoScaleProperties	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	LibraryInfo[]	List of custom libraries/packages associated with the spark pool.
properties.defaultSparkLogFolder	string	The default folder where Spark logs will be written.
properties.dynamicExecutorAllocation	DynamicExecutorAllocation	Dynamic Executor Allocation
properties.isAutotuneEnabled	boolean	Enable Autotune Whether autotune is required or not.
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	LibraryRequirements	Spark pool library version requirements Library version requirements
properties.nodeCount	integer	The number of nodes in the Big Data pool.
properties.nodeSize	NodeSize	The level of compute power that each node in the Big Data pool has.
properties.nodeSizeFamily	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	SparkConfigProperties	Spark pool Config Properties 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	BigDataPoolResourceInfo[]	List of Big Data pools

ConfigurationType

The type of the spark config properties file.

Name	Type	Description
Artifact	string
File	string

DynamicExecutorAllocation

Dynamic Executor Allocation Properties

Name	Type	Description
enabled	boolean	Indicates whether Dynamic Executor Allocation is enabled or not.
maxExecutors	integer	The maximum number of executors alloted
minExecutors	integer	The minimum number of executors alloted

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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
HardwareAcceleratedFPGA	string
HardwareAcceleratedGPU	string
MemoryOptimized	string
None	string

SparkConfigProperties

Spark pool Config Properties

Name	Type	Description
configurationType	ConfigurationType	The type of the spark config properties file.
content	string	The spark config properties.
filename	string	The filename of the spark config properties file.
time	string	The last update time of the spark config properties file.