다음을 통해 공유

Database Columns - List By Database

서비스:
SQL Database
API 버전:
2023-08-01

데이터베이스 열 나열

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
databaseName
 path True

string

데이터베이스의 이름입니다.
resourceGroupName
 path True

string

리소스를 포함하는 리소스 그룹의 이름입니다. Azure Resource Manager 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[]

응답

Name 형식 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 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=2023-08-01

샘플 응답

상태 코드:
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

샘플 요청

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

샘플 응답

상태 코드:
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"
    }
  ]
}

정의

Name 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

데이터베이스 열 리소스입니다.

Name 형식 Description
id

string

리소스 ID입니다.
name

string

리소스 이름입니다.
properties.columnType

ColumnDataType

열 데이터 형식입니다.
properties.isComputed

boolean

열이 계산되는지 여부입니다.
properties.memoryOptimized

boolean

열이 메모리 최적화 테이블에 속하는지 여부입니다.
properties.temporalType

TableTemporalType

테이블 임시 형식입니다.
type

string

리소스 종류입니다.

DatabaseColumnListResult

Object

데이터베이스 열 목록입니다.

Name 형식 Description
nextLink

string

결과의 다음 페이지를 검색하는 링크입니다.
value

DatabaseColumn[]

결과 배열입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

TableTemporalType

열거형

테이블 임시 형식입니다.

값 Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable