Database Columns - List By Table
List database columns
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns?api-version=2023-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns?$filter={$filter}&api-version=2023-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
database
|
path | True |
string |
The name of the database. |
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. |
schema
|
path | True |
string |
The name of the schema. |
server
|
path | True |
string |
The name of the server. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
table
|
path | True |
string |
The name of the table. |
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 |
Successfully retrieved database columns. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
List database columns
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col1",
"name": "col1",
"type": "Microsoft.Sql/servers/databases/schemas/tables/columns",
"properties": {
"columnType": "nvarchar",
"temporalType": "NonTemporalTable",
"memoryOptimized": false,
"isComputed": false
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
"name": "col2",
"type": "Microsoft.Sql/servers/databases/schemas/tables/columns",
"properties": {
"columnType": "bit",
"temporalType": "NonTemporalTable",
"memoryOptimized": false,
"isComputed": false
}
}
]
}
Definitions
Name | Description |
---|---|
Column |
The column data type. |
Database |
A database column resource. |
Database |
A list of database columns. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Table |
The table temporal type. |
ColumnDataType
The column data type.
Value | Description |
---|---|
image | |
text | |
uniqueidentifier | |
date | |
time | |
datetime2 | |
datetimeoffset | |
tinyint | |
smallint | |
int | |
smalldatetime | |
real | |
money | |
datetime | |
float | |
sql_variant | |
ntext | |
bit | |
decimal | |
numeric | |
smallmoney | |
bigint | |
hierarchyid | |
geometry | |
geography | |
varbinary | |
varchar | |
binary | |
char | |
timestamp | |
nvarchar | |
nchar | |
xml | |
sysname |
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. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
TableTemporalType
The table temporal type.
Value | Description |
---|---|
NonTemporalTable | |
HistoryTable | |
SystemVersionedTemporalTable |