Database Columns - Get

Tjänst:

SQL Database

API-version:

2025-01-01

Hämta databaskolumn

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

Name	I	Obligatorisk	Typ	Description
columnName	path	True	string	Kolumnens namn.
databaseName	path	True	string	Namnet på databasen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
schemaName	path	True	string	Namnet på schemat.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
tableName	path	True	string	Tabellens namn.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	DatabaseColumn	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

Get database column

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ColumnDataType	Kolumndatatypen.
createdByType	Den typ av identitet som skapade resursen.
DatabaseColumn	En databaskolumnresurs.
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"

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