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 パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
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	ErrorResponse	エラー応答: *** 400 UnsupportedColumnOrderByProperty - order-by プロパティ '{0}' はサポートされていません。使用できるプロパティは、{1}です。 400 UnsupportedColumnSortDirection - 列の並べ替え方向 '{0}' はサポートされていません。使用できる値は、{1}です。 400 UpdateNotAllowedOnPausedDatabase - ユーザーが一時停止しているデータベースで更新を実行しようとしました。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 404 SourceDatabaseNotFound - ソースデータベースが存在しません。 404 ResourceDoesNotExist - '{0}' という名前のリソースが存在しません。続行するには、有効なリソース名を指定します。 503 DatabaseUnavailable - データベースが使用できないため、操作に失敗しました。

名前

型

説明

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"
    }
  ]
}

定義

名前	説明
ColumnDataType	列のデータ型。
DatabaseColumn	データベース列リソース。
DatabaseColumnListResult	データベース列の一覧。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
TableTemporalType	テーブルのテンポラル型。

ColumnDataType

列挙

列のデータ型。

値	説明
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

データベース列リソース。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.columnType	ColumnDataType	列のデータ型。
properties.isComputed	boolean	列が計算されるかどうか。
properties.memoryOptimized	boolean	列がメモリ最適化テーブルに属しているかどうか。
properties.temporalType	TableTemporalType	テーブルのテンポラル型。
type	string	リソースの種類。

DatabaseColumnListResult

Object

データベース列の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	DatabaseColumn[]	結果の配列。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

TableTemporalType

列挙

テーブルのテンポラル型。

値	説明
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable