Database Columns - List By Database

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

データベース列を一覧表示する

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

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns?schema={schema}&table={table}&column={column}&orderBy={orderBy}&$skiptoken={$skiptoken}&api-version=2021-11-01

URI パラメーター

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

名前

型

説明

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 database columns

List database columns

Filter database columns

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/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


import java.util.Arrays;

/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void filterDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", Arrays.asList("dbo"), Arrays.asList("customer", "address"), Arrays.asList("username"),
            Arrays.asList("schema asc", "table", "column desc"), null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "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/customer/columns/username",
      "name": "username",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns"
    }
  ]
}

List database columns

要求のサンプル

HTTP
Java

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


/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ColumnsListByDatabaseMin.json
     */
    /**
     * Sample code: List database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "properties": {
        "columnType": "int",
        "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/col1",
      "name": "col1",
      "type": "Microsoft.Sql/servers/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/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns"
    }
  ]
}

定義

名前	説明
ColumnDataType	列のデータ型。
DatabaseColumn	データベース列リソース。
DatabaseColumnListResult	データベース列の一覧。
TableTemporalType	テーブルテンポラル型。

ColumnDataType

列のデータ型。

名前	型	説明
bigint	string
binary	string
bit	string
char	string
date	string
datetime	string
datetime2	string
datetimeoffset	string
decimal	string
float	string
geography	string
geometry	string
hierarchyid	string
image	string
int	string
money	string
nchar	string
ntext	string
numeric	string
nvarchar	string
real	string
smalldatetime	string
smallint	string
smallmoney	string
sql_variant	string
sysname	string
text	string
time	string
timestamp	string
tinyint	string
uniqueidentifier	string
varbinary	string
varchar	string
xml	string

DatabaseColumn

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

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

DatabaseColumnListResult

データベース列の一覧。

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

TableTemporalType

テーブルテンポラル型。

名前	型	説明
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

次の方法で共有

Database Columns - List By Database

URI パラメーター

応答

例

Filter database columns

要求のサンプル

応答のサンプル

List database columns

要求のサンプル

応答のサンプル

定義

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

その他のリソース