Sql Pools - List By Workspace

Service:

Synapse

API Version:

2021-06-01

List SQL pools
List all SQL pools

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

URI Parameters

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

Responses

Name	Type	Description
200 OK	SqlPoolInfoListResult
Other Status Codes	ErrorResponse

Examples

List SQL Analytics pools in a workspace

List SQL Analytics pools in a workspace with filter

List SQL Analytics pools in a workspace

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools?api-version=2021-06-01

Java

/**
 * Samples for SqlPools ListByWorkspace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.json
     */
    /**
     * Sample code: List SQL Analytics pools in a workspace.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void listSQLAnalyticsPoolsInAWorkspace(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.sqlPools().listByWorkspace("sqlcrudtest-6845", "sqlcrudtest-7177", 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_sql_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="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pools.list_by_workspace(
        resource_group_name="sqlcrudtest-6845",
        workspace_name="sqlcrudtest-7177",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.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/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.json
func ExampleSQLPoolsClient_NewListByWorkspacePager_listSqlAnalyticsPoolsInAWorkspace() {
	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.NewSQLPoolsClient().NewListByWorkspacePager("sqlcrudtest-6845", "sqlcrudtest-7177", 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.SQLPoolInfoListResult = armsynapse.SQLPoolInfoListResult{
		// 	Value: []*armsynapse.SQLPool{
		// 		{
		// 			Name: to.Ptr("master"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:59:33.483Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](32212254720),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("GP_Gen5_2"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-1142"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-1142"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:03:34.040Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-2788"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-2788"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:00:21.067Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-6877"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-6877"),
		// 			Location: to.Ptr("Southeast Asia"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:02:28.853Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeLRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-9888"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-9888"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:01:25.347Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 	}},
		// }
	}
}

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 all SQL pools
 *
 * @summary List all SQL pools
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.json
 */
async function listSqlAnalyticsPoolsInAWorkspace() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "sqlcrudtest-6845";
  const workspaceName = "sqlcrudtest-7177";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPools.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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.json
// this example is just showing the usage of "SqlPools_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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6845";
string workspaceName = "sqlcrudtest-7177";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseSqlPoolResource
SynapseSqlPoolCollection collection = synapseWorkspace.GetSynapseSqlPools();

// invoke the operation and iterate over the result
await foreach (SynapseSqlPoolResource 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
    SynapseSqlPoolData 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/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master",
      "name": "master",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Japan East",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 32212254720,
        "creationDate": "2017-02-10T00:59:33.483Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "GRS"
      },
      "sku": {
        "name": "GP_Gen5_2"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-1142",
      "name": "sqlcrudtest-1142",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Japan East",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "creationDate": "2017-02-10T01:03:34.04Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "GRS"
      },
      "sku": {
        "name": "DW100c"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-2788",
      "name": "sqlcrudtest-2788",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Japan East",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "creationDate": "2017-02-10T01:00:21.067Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "GRS"
      },
      "sku": {
        "name": "DW100c"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-6877",
      "name": "sqlcrudtest-6877",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Southeast Asia",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "creationDate": "2017-02-10T01:02:28.853Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "LRS"
      },
      "sku": {
        "name": "DW100c"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-9888",
      "name": "sqlcrudtest-9888",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Japan East",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "creationDate": "2017-02-10T01:01:25.347Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "GRS"
      },
      "sku": {
        "name": "DW100c"
      }
    }
  ]
}

List SQL Analytics pools in a workspace with filter

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools?api-version=2021-06-01

Java

/**
 * Samples for SqlPools ListByWorkspace.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/
     * ListSqlPoolsInWorkspaceWithFilter.json
     */
    /**
     * Sample code: List SQL Analytics pools in a workspace with filter.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void
        listSQLAnalyticsPoolsInAWorkspaceWithFilter(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.sqlPools().listByWorkspace("sqlcrudtest-6845", "sqlcrudtest-7177", 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_sql_pools_in_workspace_with_filter.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="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pools.list_by_workspace(
        resource_group_name="sqlcrudtest-6845",
        workspace_name="sqlcrudtest-7177",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspaceWithFilter.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/stable/2021-06-01/examples/ListSqlPoolsInWorkspaceWithFilter.json
func ExampleSQLPoolsClient_NewListByWorkspacePager_listSqlAnalyticsPoolsInAWorkspaceWithFilter() {
	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.NewSQLPoolsClient().NewListByWorkspacePager("sqlcrudtest-6845", "sqlcrudtest-7177", 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.SQLPoolInfoListResult = armsynapse.SQLPoolInfoListResult{
		// 	Value: []*armsynapse.SQLPool{
		// 		{
		// 			Name: to.Ptr("master"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:59:33.483Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](32212254720),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("GP_Gen5_2"),
		// 			},
		// 	}},
		// }
	}
}

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 all SQL pools
 *
 * @summary List all SQL pools
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspaceWithFilter.json
 */
async function listSqlAnalyticsPoolsInAWorkspaceWithFilter() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "sqlcrudtest-6845";
  const workspaceName = "sqlcrudtest-7177";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPools.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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspaceWithFilter.json
// this example is just showing the usage of "SqlPools_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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6845";
string workspaceName = "sqlcrudtest-7177";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseSqlPoolResource
SynapseSqlPoolCollection collection = synapseWorkspace.GetSynapseSqlPools();

// invoke the operation and iterate over the result
await foreach (SynapseSqlPoolResource 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
    SynapseSqlPoolData 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/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master",
      "name": "master",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "Japan East",
      "properties": {
        "status": "Online",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 32212254720,
        "creationDate": "2017-02-10T00:59:33.483Z",
        "provisioningState": "Succeeded",
        "restorePointInTime": "0001-01-01T00:00:00Z",
        "storageAccountType": "GRS"
      },
      "sku": {
        "name": "GP_Gen5_2"
      }
    }
  ]
}

Definitions

Name	Description
createMode	Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Sku	Sku
SqlPool	SQL pool
SqlPoolInfoListResult	SQL pool collection
StorageAccountType	The storage account type used to store backups for this sql pool.

createMode

Enumeration

Specifies the mode of sql pool creation.

Default: regular sql pool creation.

PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

Value	Description
Default
PointInTimeRestore
Recovery
Restore

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Sku

Object

Sku

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
name	string	The SKU name
tier	string	The service tier

SqlPool

Object

SQL pool

Name	Type	Default value	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.collation	string		Collation mode
properties.createMode	createMode		Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
properties.creationDate	string (date-time)		Date the SQL pool was created
properties.maxSizeBytes	integer (int64)		Maximum size in bytes
properties.provisioningState	string		Resource state
properties.recoverableDatabaseId	string		Backup database to restore from
properties.restorePointInTime	string (date-time)		Snapshot time to restore
properties.sourceDatabaseDeletionDate	string (date-time)		Specifies the time that the sql pool was deleted
properties.sourceDatabaseId	string		Source database to create from
properties.status	string		Resource status
properties.storageAccountType	StorageAccountType	GRS	The storage account type used to store backups for this sql pool.
sku	Sku		Sku SQL pool SKU
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SqlPoolInfoListResult

Object

SQL pool collection

Name	Type	Description
nextLink	string	Link to the next page of results
value	SqlPool[]	List of SQL pools

StorageAccountType

Enumeration

The storage account type used to store backups for this sql pool.

Value	Description
GRS
LRS