Database Columns - List By Database

Tjänst:

SQL Database

API-version:

2025-01-01

Lista databaskolumner

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

Med valfria parametrar:

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

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$skiptoken	query		string	En ogenomskinlig token som identifierar en startpunkt i samlingen.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Svar

Name	Typ	Description
200 OK	DatabaseColumnListResult	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Filter database columns

List database columns

Filter database columns

Exempelbegäran

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

Java

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

Python

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

JavaScript

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

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

Exempelsvar

Statuskod:

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

Exempelbegäran

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

Java

/**
 * 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

Python

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

JavaScript

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

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ColumnDataType	Kolumndatatypen.
createdByType	Den typ av identitet som skapade resursen.
DatabaseColumn	En databaskolumnresurs.
DatabaseColumnListResult	Svaret på en DatabaseColumn-listoperation.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.
TableTemporalType	Tabellens temporala typ.

ColumnDataType

Uppräkning

Kolumndatatypen.

Värde	Description
image	bild
text	text
uniqueidentifier	unik identifierare
date	date
time	time
datetime2	datetime2
datetimeoffset	datetimeoffset
tinyint	tinyint
smallint	Smallint
int	int
smalldatetime	smalldatetime
real	verklig / äkta
money	money
datetime	datetime
float	flyta/sväva
sql_variant	sql_variant
ntext	ntext
bit	lite grann
decimal	decimal
numeric	numeric
smallmoney	småpengar
bigint	bigint
hierarchyid	hierarchyid
geometry	geometri
geography	geografi
varbinary	varbinary
varchar	Varchar
binary	binär
char	röding
timestamp	tidsstämpel
nvarchar	nvarchar
nchar	nchar
xml	xml
sysname	sysname

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DatabaseColumn

Objekt

En databaskolumnresurs.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.columnType	ColumnDataType	Kolumndatatypen.
properties.isComputed	boolean	Om kolumnen beräknas eller inte.
properties.memoryOptimized	boolean	Om kolumnen tillhör en minnesoptimerad tabell eller inte.
properties.temporalType	TableTemporalType	Tabellens temporala typ.
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

DatabaseColumnListResult

Objekt

Svaret på en DatabaseColumn-listoperation.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	DatabaseColumn[]	Databaskolumnen på denna sida

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TableTemporalType

Uppräkning

Tabellens temporala typ.

Värde	Description
NonTemporalTable	NonTemporalTable
HistoryTable	HistoryTable
SystemVersionedTemporalTable	SystemVersionedTemporalTable