Database Columns - Get

Service:

SQL Database

Version d’API:

2025-01-01

Obtenir la colonne de base de données

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
columnName	path	True	string	Nom de la colonne.
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
schemaName	path	True	string	Nom du schéma.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
tableName	path	True	string	Nom de la table.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DatabaseColumn	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get database column

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ColumnDataType	Type de données de colonne.
createdByType	Type d’identité qui a créé la ressource.
DatabaseColumn	Ressource de colonne de base de données.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TableTemporalType	Type temporel de table.

ColumnDataType

Énumération

Type de données de colonne.

Valeur	Description
image	image
text	texte
uniqueidentifier	identifiant unique
date	date
time	temps
datetime2	datetime2
datetimeoffset	datetimeoffset
tinyint	tinyint
smallint	smallint
int	int
smalldatetime	smalldatetime
real	real
money	money
datetime	datetime
float	flotter
sql_variant	sql_variant
ntext	ntext
bit	bit
decimal	décimal
numeric	numérique
smallmoney	SMALLMONEY
bigint	bigint
hierarchyid	hierarchyid
geometry	géométrie
geography	Géographie
varbinary	varbinary
varchar	varchar
binary	binaire
char	car
timestamp	horodatage
nvarchar	NVARCHAR
nchar	NCHAR
xml	Xml
sysname	sysname

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DatabaseColumn

Objet

Ressource de colonne de base de données.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.columnType	ColumnDataType	Type de données de colonne.
properties.isComputed	boolean	Indique si la colonne est calculée ou non.
properties.memoryOptimized	boolean	Indique si la colonne appartient à une table optimisée en mémoire.
properties.temporalType	TableTemporalType	Type temporel de table.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TableTemporalType

Énumération

Type temporel de table.

Valeur	Description
NonTemporalTable	NonTemporalTable
HistoryTable	Tableau historique
SystemVersionedTemporalTable	SystemVersionedTemporalTable