Sql Pool Schemas - List

Gets schemas of a given SQL pool.

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

sqlPoolName
path True

string

SQL pool name

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.

$filter
query

string

An OData filter expression that filters elements in the collection.

Responses

Name Type Description
200 OK

SqlPoolSchemaListResult

OK

Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 SourceDatabaseNotFound - The source database does not exist.

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 404 InvalidDatabaseSchema - Schema is missing in database.

  • 404 InvalidDatabaseTable - Table is missing in database.

  • 404 InvalidDatabaseColumn - Column is missing in table.

Examples

List the schema in a SQL Analytics pool

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo",
      "name": "dbo",
      "type": "Microsoft.Synapse/workspaces/sqlPools/schemas"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/schema2",
      "name": "schema2",
      "type": "Microsoft.Synapse/workspaces/sqlPools/schemas"
    }
  ]
}

Definitions

Name Description
SqlPoolSchema

A Sql pool schema resource.

SqlPoolSchemaListResult

A list of Sql pool schemas.

SqlPoolSchema

A Sql pool schema resource.

Name Type Description
id

string

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

name

string

The name of the resource

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SqlPoolSchemaListResult

A list of Sql pool schemas.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

SqlPoolSchema[]

Array of results.