Share via

Database Columns - Get

Service:
SQL Database
API Version:
2021-11-01

Get database column

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}?api-version=2021-11-01

URI Parameters

Name In Required Type Description
columnName
 path True

string

The name of the column.
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.
tableName
 path True

string

The name of the table.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

DatabaseColumn

Successfully retrieved database column.
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 column

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/column1",
  "name": "column1",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns",
  "properties": {
    "columnType": "bit",
    "temporalType": "SystemVersionedTemporalTable",
    "memoryOptimized": false,
    "isComputed": false
  }
}

Definitions

Name Description
ColumnDataType

The column data type.
DatabaseColumn

A database column resource.
TableTemporalType

The table temporal type.

ColumnDataType

Enumeration

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

Object

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.

TableTemporalType

Enumeration

The table temporal type.

Value Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable