Database Schemas - List By Database

Service:

SQL Database

API Version:

2021-11-01

List database schemas

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas?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?$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.
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	DatabaseSchemaListResult	Successfully retrieved database schemas.
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 schemas

Sample request

HTTP

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

Java

/**
 * Samples for DatabaseSchemas ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseSchemaListByDatabase.json
     */
    /**
     * Sample code: List database schemas.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDatabaseSchemas(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseSchemas().listByDatabase("myRG", "serverName",
            "myDatabase", 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",
      "name": "dbo",
      "type": "Microsoft.Sql/servers/databases/schemas"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/schema2",
      "name": "schema2",
      "type": "Microsoft.Sql/servers/databases/schemas"
    }
  ]
}

Definitions

Name	Description
DatabaseSchema	A database schema resource.
DatabaseSchemaListResult	A list of database schemas.

DatabaseSchema

A database schema resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
type	string	Resource type.

DatabaseSchemaListResult

A list of database schemas.

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