Database Columns - List By Database

Hizmet:

SQL Database

API Sürümü:

2025-01-01

Veritabanı sütunlarını listeleme

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
databaseName	path	True	string	Veritabanının adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
$skiptoken	query		string	Koleksiyondaki bir başlangıç noktasını tanımlayan opak belirteç.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Yanıtlar

Name	Tür	Description
200 OK	DatabaseColumnListResult	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Filter database columns

List database columns

Filter database columns

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/serverName/databases/myDatabase/columns?api-version=2025-01-01&schema=dbo&table=customer&table=address&column=username&orderBy=schema asc&orderBy=table&orderBy=column desc

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ColumnsListByDatabaseMax.json
// this example is just showing the usage of "DatabaseColumns_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "serverName";
string databaseName = "myDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation and iterate over the result
IEnumerable<string> schema = new string[] { "dbo" };
IEnumerable<string> table = new string[] { "customer", "address" };
IEnumerable<string> column = new string[] { "username" };
IEnumerable<string> orderBy = new string[] { "schema asc", "table", "column desc" };
await foreach (SqlDatabaseColumnResource item in sqlDatabase.GetDatabaseColumnsAsync(schema: schema, table: table, column: column, orderBy: orderBy))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "name": "username",
      "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/customer/columns/username",
      "properties": {
        "columnType": "nvarchar",
        "isComputed": false,
        "memoryOptimized": false,
        "temporalType": "NonTemporalTable"
      }
    }
  ]
}

List database columns

Örnek isteği

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ColumnsListByDatabaseMin.json
// this example is just showing the usage of "DatabaseColumns_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "serverName";
string databaseName = "myDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation and iterate over the result
await foreach (SqlDatabaseColumnResource item in sqlDatabase.GetDatabaseColumnsAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "name": "col1",
      "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/col1",
      "properties": {
        "columnType": "int",
        "isComputed": false,
        "memoryOptimized": false,
        "temporalType": "NonTemporalTable"
      }
    },
    {
      "name": "col2",
      "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/col2",
      "properties": {
        "columnType": "bit",
        "isComputed": false,
        "memoryOptimized": false,
        "temporalType": "SystemVersionedTemporalTable"
      }
    }
  ]
}

Tanımlar

Name	Description
ColumnDataType	Sütun veri türü.
createdByType	Kaynağı oluşturan kimliğin türü.
DatabaseColumn	Veritabanı sütun kaynağı.
DatabaseColumnListResult	Bir DatabaseColumn liste işleminin yanıtı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
TableTemporalType	Tablo zamana bağlı türü.

ColumnDataType

Numaralandırma

Sütun veri türü.

Değer	Description
image	image
text	text
uniqueidentifier	uniqueidentifier
date	date
time	Zaman
datetime2	datetime2
datetimeoffset	datetimeoffset
tinyint	tinyint
smallint	smallint
int	Int
smalldatetime	smalldatetime
real	gerçek
money	para
datetime	tarih/zaman
float	yüzmek
sql_variant	sql_variant
ntext	ntext
bit	bit (veri birimi)
decimal	ondalık
numeric	sayısal
smallmoney	smallmoney
bigint	bigint
hierarchyid	hierarchyid
geometry	geometri
geography	coğrafya
varbinary	varbinary
varchar	Varchar Belediyesi
binary	ikili
char	char
timestamp	Tarih damgası
nvarchar	nvarchar
nchar	nchar
xml	xml
sysname	sysname

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DatabaseColumn

Nesne

Veritabanı sütun kaynağı.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.columnType	ColumnDataType	Sütun veri türü.
properties.isComputed	boolean	Sütunun hesaplanıp hesaplanmadığı.
properties.memoryOptimized	boolean	Sütunun bellek için iyileştirilmiş bir tabloya ait olup olmadığı.
properties.temporalType	TableTemporalType	Tablo zamana bağlı türü.
systemData	systemData	Azure Resource Manager metadata içeren createdBy ve modifiedBy bilgileri.
type	string	Kaynağın türü. Örneğin "Microsoft. Compute/virtualMachines" veya "Microsoft. Depo/Depolama Hesapları"

DatabaseColumnListResult

Nesne

Bir DatabaseColumn liste işleminin yanıtı.

Name	Tür	Description
nextLink	string (uri)	Öğelerin bir sonraki sayfasına bağlantı
value	DatabaseColumn[]	Bu sayfadaki DatabaseColumn öğeleri

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

TableTemporalType

Numaralandırma

Tablo zamana bağlı türü.

Değer	Description
NonTemporalTable	NonTemporalTable
HistoryTable	HistoryTable
SystemVersionedTemporalTable	SystemVersionedTemporalTable