Managed Database Columns - List By Database

Reference

Service:: SQL Database

API Version:: 2021-11-01

List managed database columns

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/columns?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/columns?schema={schema}&table={table}&column={column}&orderBy={orderBy}&$skiptoken={$skiptoken}&api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
managedInstanceName	path	True	string	The name of the managed instance.
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.
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.
$skiptoken	query		string	An opaque token that identifies a starting point in the collection.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Responses

Name	Type	Description
200 OK	DatabaseColumnListResult	Successfully retrieved database columns.
Other Status Codes		* Error Responses: * 400 UnsupportedColumnOrderByProperty - The order-by property '{0}' is not supported. Allowed properties are: {1}. 400 UnsupportedColumnSortDirection - The column sort direction '{0}' is not supported. Allowed values are: {1}. 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. 503 DatabaseUnavailable - The operation failed because the database is unavailable.

Name

Type

Description

200 OK

DatabaseColumnListResult

Successfully retrieved database columns.

Other Status Codes

*** Error Responses: ***

400 UnsupportedColumnOrderByProperty - The order-by property '{0}' is not supported. Allowed properties are: {1}.
400 UnsupportedColumnSortDirection - The column sort direction '{0}' is not supported. Allowed values are: {1}.
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.
503 DatabaseUnavailable - The operation failed because the database is unavailable.

Examples

Filter managed database columns

List managed database columns

Filter managed database columns

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/columns?schema=dbo&table=customer&table=address&column=username&orderBy=schema asc&orderBy=table&orderBy=column desc&api-version=2021-11-01


import com.azure.core.util.Context;
import java.util.Arrays;

/** Samples for ManagedDatabaseColumns ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter managed database columns.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void filterManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", Arrays.asList("dbo"), Arrays.asList("customer", "address"), Arrays.asList("username"),
            Arrays.asList("schema asc", "table", "column desc"), null, 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": [
    {
      "properties": {
        "columnType": "nvarchar",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/customer/columns/username",
      "name": "username",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

List managed database columns

Sample Request

HTTP
Java

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


import com.azure.core.util.Context;

/** Samples for ManagedDatabaseColumns ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMin.json
     */
    /**
     * Sample code: List managed database columns.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", null, null, null, null, null, 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": [
    {
      "properties": {
        "columnType": "int",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col1",
      "name": "col1",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    },
    {
      "properties": {
        "columnType": "bit",
        "temporalType": "SystemVersionedTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

Definitions

Name	Description
ColumnDataType	The column data type.
DatabaseColumn	A database column resource.
DatabaseColumnListResult	A list of database columns.
TableTemporalType	The table temporal type.

ColumnDataType

The column data type.

Name	Type	Description
bigint	string
binary	string
bit	string
char	string
date	string
datetime	string
datetime2	string
datetimeoffset	string
decimal	string
float	string
geography	string
geometry	string
hierarchyid	string
image	string
int	string
money	string
nchar	string
ntext	string
numeric	string
nvarchar	string
real	string
smalldatetime	string
smallint	string
smallmoney	string
sql_variant	string
sysname	string
text	string
time	string
timestamp	string
tinyint	string
uniqueidentifier	string
varbinary	string
varchar	string
xml	string

DatabaseColumn

A database column resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.columnType	ColumnDataType	The column data type.
properties.isComputed	boolean	Whether or not the column is computed.
properties.memoryOptimized	boolean	Whether or not the column belongs to a memory optimized table.
properties.temporalType	TableTemporalType	The table temporal type.
type	string	Resource type.

DatabaseColumnListResult

A list of database columns.

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

TableTemporalType

The table temporal type.

Name	Type	Description
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Share via

Managed Database Columns - List By Database

URI Parameters

Responses

Examples

Filter managed database columns

Sample Request

Sample Response

List managed database columns

Sample Request

Sample Response

Definitions

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Additional resources