Database Tables - List By Schema

Service:

SQL Database

API Version:

2021-11-01

List database tables

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables?$filter={$filter}&api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName	path	True	string	The name of the schema.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.
$filter	query		string	An OData filter expression that filters elements in the collection.

Responses

Name	Type	Description
200 OK	DatabaseTableListResult	Successfully retrieved database tables.
Other Status Codes		*** Error Responses: *** 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database. 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 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name. 404 InvalidDatabaseSchema - Schema is missing in database. 404 InvalidDatabaseTable - Table is missing in database. 404 InvalidDatabaseColumn - Column is missing in table. 503 DatabaseUnavailable - The operation failed because the database is unavailable.

Examples

List database tables

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables?api-version=2021-11-01

Java

/**
 * Samples for DatabaseTables ListBySchema.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseTableListBySchema.json
     */
    /**
     * Sample code: List database tables.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDatabaseTables(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseTables().listBySchema("myRG", "serverName",
            "myDatabase", "dbo", null, 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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1",
      "name": "table1",
      "type": "Microsoft.Sql/servers/databases/schemas/tables"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table2",
      "name": "table2",
      "type": "Microsoft.Sql/servers/databases/schemas/tables"
    }
  ]
}

Definitions

Name	Description
DatabaseTable	A database table resource.
DatabaseTableListResult	A list of database tables.
TableTemporalType	The table temporal type.

DatabaseTable

A database table resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.memoryOptimized	boolean	Whether or not the table is memory optimized.
properties.temporalType	TableTemporalType	The table temporal type.
type	string	Resource type.

DatabaseTableListResult

A list of database tables.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	DatabaseTable[]	Array of results.

TableTemporalType

The table temporal type.

Name	Type	Description
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string