Managed Database Columns - List By Database

Service:: SQL Database

Version d’API:: 2025-01-01

Répertorier les colonnes de base de données managées

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
managedInstanceName	path	True	string	Nom de l’instance managée.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$skiptoken	query		string	Jeton opaque qui identifie un point de départ dans la collection.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Réponses

Nom	Type	Description
200 OK	DatabaseColumnListResult	Colonnes de base de données récupérées avec succès.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 UnsupportedColumnOrderByProperty - La propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont les suivantes : {1}. 400 UnsupportedColumnSortDirection - Le sens de tri de colonne '{0}' n’est pas pris en charge. Les valeurs autorisées sont les suivantes : {1}. 400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données suspendue. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur. 404 SourceDatabaseNotFound : la base de données source n’existe pas. 404 ResourceDoesNotExist - Ressource portant le nom '{0}' n’existe pas. Pour continuer, spécifiez un nom de ressource valide. 503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Nom

Type

Description

200 OK

DatabaseColumnListResult

Colonnes de base de données récupérées avec succès.

Other Status Codes

ErrorResponse

Réponses d’erreur : ***

400 UnsupportedColumnOrderByProperty - La propriété order-by '{0}' n’est pas prise en charge. Les propriétés autorisées sont les suivantes : {1}.
400 UnsupportedColumnSortDirection - Le sens de tri de colonne '{0}' n’est pas pris en charge. Les valeurs autorisées sont les suivantes : {1}.
400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données suspendue.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur.
404 SourceDatabaseNotFound : la base de données source n’existe pas.
404 ResourceDoesNotExist - Ressource portant le nom '{0}' n’existe pas. Pour continuer, spécifiez un nom de ressource valide.
503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Exemples

Filter managed database columns

List managed database columns

Filter managed database columns

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "properties": {
        "columnType": "nvarchar",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/customer/columns/username",
      "name": "username",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

List managed database columns

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "properties": {
        "columnType": "int",
        "temporalType": "NonTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col1",
      "name": "col1",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    },
    {
      "properties": {
        "columnType": "bit",
        "temporalType": "SystemVersionedTemporalTable",
        "memoryOptimized": false,
        "isComputed": false
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/serverName/databases/myDatabase/schemas/dbo/tables/table1/columns/col2",
      "name": "col2",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns"
    }
  ]
}

Définitions

Nom	Description
ColumnDataType	Type de données de colonne.
DatabaseColumn	Ressource de colonne de base de données.
DatabaseColumnListResult	Liste des colonnes 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
TableTemporalType	Type temporel de table.

ColumnDataType

Énumération

Type de données de colonne.

Valeur	Description
image
text
uniqueidentifier
date
time
datetime2
datetimeoffset
tinyint
smallint
int
smalldatetime
real
money
datetime
float
sql_variant
ntext
bit
decimal
numeric
smallmoney
bigint
hierarchyid
geometry
geography
varbinary
varchar
binary
char
timestamp
nvarchar
nchar
xml
sysname

DatabaseColumn

Objet

Ressource de colonne de base de données.

Nom	Type	Description
id	string	ID de la ressource
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.
type	string	Type de ressource.

DatabaseColumnListResult

Objet

Liste des colonnes de base de données.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page suivante des résultats.
value	DatabaseColumn[]	Tableau de résultats.

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.

TableTemporalType

Énumération

Type temporel de table.

Valeur	Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable