Managed Database Columns - List By Database
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
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 |
---|---|---|---|---|
database
|
path | True |
string |
The name of the database. |
managed
|
path | True |
string |
The name of the managed instance. |
resource
|
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. |
subscription
|
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[] |
||
order
|
query |
string[] |
||
schema
|
query |
string[] |
||
table
|
query |
string[] |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved database columns. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Filter managed database columns |
List managed database columns |
Filter managed database columns
Sample request
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
Sample response
{
"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
Sample response
{
"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 |
---|---|
Column |
The column data type. |
Database |
A database column resource. |
Database |
A list of database columns. |
Table |
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 |
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 |
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 |
Array of results. |
TableTemporalType
The table temporal type.
Name | Type | Description |
---|---|---|
HistoryTable |
string |
|
NonTemporalTable |
string |
|
SystemVersionedTemporalTable |
string |