你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sql Pools - List By Workspace

参考

Service:: Synapse

API Version:: 2021-06-01

列出 SQL 池
列出所有 SQL 池

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
workspaceName	path	True	string	工作区的名称。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	SqlPoolInfoListResult
Other Status Codes	ErrorResponse

示例

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

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

/** 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

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

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

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

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/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

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

/** 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

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

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

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

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/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"
      }
    }
  ]
}

定义

名称	说明
createMode	指定 sql 池创建模式。默认值：常规 sql 池创建。 PointInTimeRestore：通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID，并且必须指定 restorePointInTime。恢复：通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为 recoverableDatabaseId 才能还原。还原：通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应该是 sql 池的原始资源 ID。必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Sku	SKU
SqlPool	SQL 池
SqlPoolInfoListResult	SQL 池集合
StorageAccountType	用于存储此 sql 池备份的存储帐户类型。

createMode

指定 sql 池创建模式。

默认值：常规 sql 池创建。

PointInTimeRestore：通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID，并且必须指定 restorePointInTime。

恢复：通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为 recoverableDatabaseId 才能还原。

还原：通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应该是 sql 池的原始资源 ID。必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。

名称	类型	说明
Default	string
PointInTimeRestore	string
Recovery	string
Restore	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Sku

SKU

名称	类型	说明
capacity	integer	如果 SKU 支持横向扩展/缩减，则应包含容量整数。如果资源无法横向扩展/缩减，则可能会省略这一点。
name	string	SKU 名称
tier	string	服务层

SqlPool

SQL 池

名称	类型	默认值	说明
id	string		资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		资源所在的地理位置
name	string		资源的名称
properties.collation	string		排序规则模式
properties.createMode	createMode		指定 sql 池创建模式。默认值：常规 sql 池创建。 PointInTimeRestore：通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID，并且必须指定 restorePointInTime。恢复：通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为 recoverableDatabaseId 才能还原。还原：通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应该是 sql 池的原始资源 ID。必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。
properties.creationDate	string		SQL 池的创建日期
properties.maxSizeBytes	integer		最大大小（以字节为单位）
properties.provisioningState	string		资源状态
properties.recoverableDatabaseId	string		要从中还原的备份数据库
properties.restorePointInTime	string		要还原的快照时间
properties.sourceDatabaseDeletionDate	string		指定删除 sql 池的时间
properties.sourceDatabaseId	string		要从中创建的源数据库
properties.status	string		资源状态
properties.storageAccountType	StorageAccountType	GRS	用于存储此 sql 池备份的存储帐户类型。
sku	Sku		SKU SQL 池 SKU
tags	object		资源标记。
type	string		资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SqlPoolInfoListResult

SQL 池集合

名称	类型	说明
nextLink	string	链接到结果的下一页
value	SqlPool[]	SQL 池列表

StorageAccountType

用于存储此 sql 池备份的存储帐户类型。

名称	类型	说明
GRS	string
LRS	string

Sql Pools - List By Workspace

URI 参数

响应

示例

List SQL Analytics pools in a workspace

Sample Request

Sample Response

List SQL Analytics pools in a workspace with filter

Sample Request

Sample Response

定义

createMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SqlPool

SqlPoolInfoListResult

StorageAccountType

其他资源