Database Columns - List By Database

Dienst:: SQL Database

API-Version:: 2025-01-01

Listendatenbankspalten

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

Mit optionalen Parametern:

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$skiptoken	query		string	Ein undurchsichtiges Token, das einen Ausgangspunkt in der Sammlung identifiziert.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseColumnListResult	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Filter database columns

List database columns

Filter database columns

Beispielanforderung

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


import java.util.Arrays;

/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter database columns.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void filterDatabaseColumns(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python columns_list_by_database_max.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.list_by_database(
        resource_group_name="myRG",
        server_name="serverName",
        database_name="myDatabase",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMax.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

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

/**
 * This sample demonstrates how to list database columns
 *
 * @summary list database columns
 * x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMax.json
 */
async function filterDatabaseColumns() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.databaseColumns.listByDatabase(
    "myRG",
    "serverName",
    "myDatabase",
    {
      schema: ["dbo"],
      table: ["customer", "address"],
      column: ["username"],
      orderBy: ["schema asc", "table", "column desc"],
    },
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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


/**
 * Samples for DatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMin.json
     */
    /**
     * Sample code: List database columns.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void listDatabaseColumns(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python columns_list_by_database_min.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.list_by_database(
        resource_group_name="myRG",
        server_name="serverName",
        database_name="myDatabase",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMin.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

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

/**
 * This sample demonstrates how to list database columns
 *
 * @summary list database columns
 * x-ms-original-file: 2025-01-01/ColumnsListByDatabaseMin.json
 */
async function listDatabaseColumns() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.databaseColumns.listByDatabase(
    "myRG",
    "serverName",
    "myDatabase",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ColumnDataType	Der Spaltendatentyp.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DatabaseColumn	Eine Datenbankspaltenressource.
DatabaseColumnListResult	Die Antwort einer DatabaseColumn-Listenoperation.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TableTemporalType	Der zeitliche Tabellentyp.

ColumnDataType

Enumeration

Der Spaltendatentyp.

Wert	Beschreibung
image	image
text	Text
uniqueidentifier	eindeutiger Bezeichner
date	date
time	Zeit
datetime2	datetime2
datetimeoffset	datetimeoffset
tinyint	tinyint
smallint	smallint
int	int
smalldatetime	smalldatetime
real	real
money	Geld
datetime	Datum/Uhrzeit
float	Schweben
sql_variant	sql_variant
ntext	ntext
bit	bit
decimal	Dezimalzahl
numeric	numerisch
smallmoney	smallmoney
bigint	BIGINT
hierarchyid	hierarchyid
geometry	Geometrie
geography	Geographie
varbinary	varbinary
varchar	varchar
binary	binär
char	verkohlen
timestamp	Zeitstempel
nvarchar	NVARCHAR
nchar	NCHAR
xml	xml
sysname	sysname

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DatabaseColumn

Objekt

Eine Datenbankspaltenressource.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.columnType	ColumnDataType	Der Spaltendatentyp.
properties.isComputed	boolean	Gibt an, ob die Spalte berechnet wird.
properties.memoryOptimized	boolean	Gibt an, ob die Spalte zu einer speicheroptimierten Tabelle gehört.
properties.temporalType	TableTemporalType	Der zeitliche Tabellentyp.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

DatabaseColumnListResult

Objekt

Die Antwort einer DatabaseColumn-Listenoperation.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	DatabaseColumn[]	Die DatabaseColumn-Einträge auf dieser Seite

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TableTemporalType

Enumeration

Der zeitliche Tabellentyp.

Wert	Beschreibung
NonTemporalTable	NonTemporalTable
HistoryTable	Geschichtstabelle
SystemVersionedTemporalTable	SystemVersionedTemporalTable