Database Columns - Get

서비스:

SQL Database

API 버전:

2025-01-01

데이터베이스 열 가져오기

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}?api-version=2025-01-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
columnName	path	True	string	열 이름입니다.
databaseName	path	True	string	데이터베이스의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
schemaName	path	True	string	스키마의 이름입니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
tableName	path	True	string	테이블의 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	DatabaseColumn	Azure 운영이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get database column

샘플 요청

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/column1?api-version=2025-01-01

Java

/**
 * Samples for DatabaseColumns Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DatabaseColumnGet.json
     */
    /**
     * Sample code: Get database column.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getDatabaseColumn(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDatabaseColumns().getWithResponse("myRG", "serverName", "myDatabase", "dbo",
            "table1", "column1", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python database_column_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_columns.get(
        resource_group_name="myRG",
        server_name="serverName",
        database_name="myDatabase",
        schema_name="dbo",
        table_name="table1",
        column_name="column1",
    )
    print(response)


# x-ms-original-file: 2025-01-01/DatabaseColumnGet.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get database column
 *
 * @summary get database column
 * x-ms-original-file: 2025-01-01/DatabaseColumnGet.json
 */
async function getDatabaseColumn() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseColumns.get(
    "myRG",
    "serverName",
    "myDatabase",
    "dbo",
    "table1",
    "column1",
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/DatabaseColumnGet.json
// this example is just showing the usage of "DatabaseColumns_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseColumnResource created on azure
// for more information of creating SqlDatabaseColumnResource, please refer to the document of SqlDatabaseColumnResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "serverName";
string databaseName = "myDatabase";
string schemaName = "dbo";
string tableName = "table1";
string columnName = "column1";
ResourceIdentifier sqlDatabaseColumnResourceId = SqlDatabaseColumnResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, schemaName, tableName, columnName);
SqlDatabaseColumnResource sqlDatabaseColumn = client.GetSqlDatabaseColumnResource(sqlDatabaseColumnResourceId);

// invoke the operation
SqlDatabaseColumnResource result = await sqlDatabaseColumn.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DatabaseColumnData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

샘플 응답

상태 코드:

200

{
  "name": "column1",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/column1",
  "properties": {
    "columnType": "bit",
    "isComputed": false,
    "memoryOptimized": false,
    "temporalType": "SystemVersionedTemporalTable"
  }
}

정의

Name	Description
ColumnDataType	열 데이터 형식입니다.
createdByType	리소스를 만든 ID의 형식입니다.
DatabaseColumn	데이터베이스 열 리소스입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
TableTemporalType	테이블 임시 형식입니다.

ColumnDataType

열거형

열 데이터 형식입니다.

값	Description
image	이미지
text	문자 메시지
uniqueidentifier	uniqueidentifier
date	날짜
time	시간
datetime2	날짜시간2
datetimeoffset	datetimeoffset
tinyint	tinyint
smallint	스몰인트
int	int
smalldatetime	smalldatetime
real	real
money	money
datetime	datetime
float	떠다니다
sql_variant	sql_variant (SQL서버 데이터 유형 다양성)
ntext	ntext
bit	bit
decimal	십진수
numeric	숫자
smallmoney	소액돈
bigint	빅인트 (bigint)
hierarchyid	계층 ID
geometry	기하학
geography	지리학
varbinary	바바이너리
varchar	varchar
binary	이진법
char	문자(char)
timestamp	시간표시
nvarchar	nvarchar
nchar	nchar (고정 길이 문자형 데이터 타입)
xml	Xml
sysname	sysname

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DatabaseColumn

Object

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

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties.columnType	ColumnDataType	열 데이터 형식입니다.
properties.isComputed	boolean	열이 계산되는지 여부입니다.
properties.memoryOptimized	boolean	열이 메모리 최적화 테이블에 속하는지 여부입니다.
properties.temporalType	TableTemporalType	테이블 임시 형식입니다.
systemData	systemData	Azure Resource Manager 메타데이터에 createdBy 및 modifiedBy 정보가 포함되어 있습니다.
type	string	리소스의 형식입니다. 예를 들어, "Microsoft. 컴퓨트/가상 머신" 또는 "Microsoft." 저장소/저장소 계정"

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	오류 개체입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

TableTemporalType

열거형

테이블 임시 형식입니다.

값	Description
NonTemporalTable	비시간적 테이블
HistoryTable	역사표
SystemVersionedTemporalTable	SystemVersionedTemporalTable