Database Schemas - Get

Service:

SQL Database

API Version:

2021-11-01

Get database schema

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

Responses

Name	Type	Description
200 OK	DatabaseSchema	Successfully retrieved database schema.
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

Get database schema

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?api-version=2021-11-01

Java

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

{
  "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"
}

Definitions

DatabaseSchema

A database schema resource.

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