Поделиться через

Managed Database Columns - List By Database

  • Ссылка
Служба:
SQL Database
Версия API:
2021-11-01

Вывод списка столбцов управляемой базы данных

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

Имя В Обязательно Тип Описание
databaseName
 path True

string

Имя базы данных.
managedInstanceName
 path True

string

Имя управляемого экземпляра.
resourceGroupName
 path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
subscriptionId
 path True

string

Идентификатор подписки Azure.
api-version
 query True

string

Версия API для использования в запросе.
$skiptoken
 query

string

Непрозрачный маркер, определяющий начальную точку в коллекции.
column
 query

string[]

orderBy
 query

string[]

schema
 query

string[]

table
 query

string[]

Ответы

Имя Тип Описание
200 OK

DatabaseColumnListResult

Столбцы базы данных успешно получены.
Other Status Codes

Ответы об ошибках: ***

  • 400 UnsupportedColumnOrderByProperty — свойство order-by "{0}" не поддерживается. Допустимые свойства: {1}.

  • 400 UnsupportedColumnSortDirection — направление сортировки столбца "{0}" не поддерживается. Допустимые значения: {1}.

  • 400 UpdateNotAllowedOnPausedDatabase — пользователь пытался выполнить обновление приостановленной базы данных.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден.

  • 404 SourceDatabaseNotFound — база данных-источник не существует.

  • 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует в этом экземпляре сервера.

  • 404 ResourceDoesNotExist — ресурс с именем "{0}" не существует. Для продолжения укажите допустимое имя ресурса.

  • 503 DatabaseUnavailable — операция завершилась сбоем, так как база данных недоступна.

Примеры

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

Пример ответа

Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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"
    }
  ]
}

Определения

Имя Описание
ColumnDataType

Тип данных столбца.
DatabaseColumn

Ресурс столбца базы данных.
DatabaseColumnListResult

Список столбцов базы данных.
TableTemporalType

Темпоральный тип таблицы.

ColumnDataType

Enumeration

Тип данных столбца.

Значение Описание
bigint
binary
bit
char
date
datetime
datetime2
datetimeoffset
decimal
float
geography
geometry
hierarchyid
image
int
money
nchar
ntext
numeric
nvarchar
real
smalldatetime
smallint
smallmoney
sql_variant
sysname
text
time
timestamp
tinyint
uniqueidentifier
varbinary
varchar
xml

DatabaseColumn

Object

Ресурс столбца базы данных.

Имя Тип Описание
id

string

Идентификатор ресурса.
name

string

Имя ресурса.
properties.columnType

ColumnDataType

Тип данных столбца.
properties.isComputed

boolean

Указывает, вычисляется ли столбец.
properties.memoryOptimized

boolean

Относится ли столбец к таблице, оптимизированной для памяти.
properties.temporalType

TableTemporalType

Темпоральный тип таблицы.
type

string

Тип ресурса.

DatabaseColumnListResult

Object

Список столбцов базы данных.

Имя Тип Описание
nextLink

string

Ссылка для получения следующей страницы результатов.
value

DatabaseColumn[]

Массив результатов.

TableTemporalType

Enumeration

Темпоральный тип таблицы.

Значение Описание
HistoryTable
NonTemporalTable
SystemVersionedTemporalTable