Database Schemas - List By Database

Service:: SQL Database

API Version:: 2023-08-01

List database schemas

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas?api-version=2023-08-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=2023-08-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	ErrorResponse	* Error Responses: * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 SourceDatabaseNotFound - The source database does not exist. 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.

Name

Type

Description

200 OK

DatabaseSchemaListResult

Successfully retrieved database schemas.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
404 SourceDatabaseNotFound - The source database does not exist.
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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseSchemaListByDatabase.json
// this example is just showing the usage of "DatabaseSchemas_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "serverName";
string databaseName = "myDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SqlDatabaseSchemaResource
SqlDatabaseSchemaCollection collection = sqlDatabase.GetSqlDatabaseSchemas();

// invoke the operation and iterate over the result
await foreach (SqlDatabaseSchemaResource 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
    DatabaseSchemaData 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/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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DatabaseSchema

Object

A database schema resource.

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

DatabaseSchemaListResult

Object

A list of database schemas.

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

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.

Share via

Database Schemas - List By Database

URI Parameters

Responses

Examples

List database schemas

Sample request

Sample response

Definitions

DatabaseSchema

DatabaseSchemaListResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse