Managed Database Columns - List By Database

服務:: SQL Database

API 版本:: 2025-01-01

列出受控資料庫數據行

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/columns?api-version=2025-01-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=2025-01-01

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
managedInstanceName	path	True	string	受控實例的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
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[]

回應

名稱	類型	Description
200 OK	DatabaseColumnListResult	成功擷取的資料庫數據行。
Other Status Codes	ErrorResponse	錯誤回應： *** 400 UnsupportedColumnOrderByProperty - 不支援 order-by 属性 '{0}'。允許的屬性為：{1}。 400 UnsupportedColumnSortDirection - 不支持數據行排序方向 '{0}'。允許的值為：{1}。 400 UpdateNotAllowedOnPausedDatabase - 使用者嘗試在暫停的資料庫上執行更新。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。 404 SourceDatabaseNotFound - 源資料庫不存在。 404 ResourceDoesNotExist - 名稱為 '{0}' 的資源不存在。若要繼續，請指定有效的資源名稱。 503 DatabaseUnavailable - 作業失敗，因為資料庫無法使用。

名稱

類型

Description

200 OK

DatabaseColumnListResult

成功擷取的資料庫數據行。

Other Status Codes

ErrorResponse

錯誤回應： ***

400 UnsupportedColumnOrderByProperty - 不支援 order-by 属性 '{0}'。允許的屬性為：{1}。
400 UnsupportedColumnSortDirection - 不支持數據行排序方向 '{0}'。允許的值為：{1}。
400 UpdateNotAllowedOnPausedDatabase - 使用者嘗試在暫停的資料庫上執行更新。
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。
404 SourceDatabaseNotFound - 源資料庫不存在。
404 ResourceDoesNotExist - 名稱為 '{0}' 的資源不存在。若要繼續，請指定有效的資源名稱。
503 DatabaseUnavailable - 作業失敗，因為資料庫無法使用。

範例

Filter managed database columns

List managed database columns

Filter managed database columns

範例要求

HTTP

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=2025-01-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

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/columns?api-version=2025-01-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"
    }
  ]
}

定義

名稱	Description
ColumnDataType	數據行數據類型。
DatabaseColumn	資料庫數據行資源。
DatabaseColumnListResult	資料庫數據列的清單。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
TableTemporalType	數據表時態型別。

ColumnDataType

列舉型別

數據行數據類型。

值	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

資料庫數據行資源。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.columnType	ColumnDataType	數據行數據類型。
properties.isComputed	boolean	是否計算數據行。
properties.memoryOptimized	boolean	數據行是否屬於記憶體優化數據表。
properties.temporalType	TableTemporalType	數據表時態型別。
type	string	資源類型。

DatabaseColumnListResult

Object

資料庫數據列的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	DatabaseColumn[]	結果的陣列。

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

TableTemporalType

列舉型別

數據表時態型別。

值	Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable