Managed Database Columns - List By Database

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Enumerar columnas de base de datos administradas

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
managedInstanceName	path	True	string	Nombre de la instancia administrada.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.
$skiptoken	query		string	Token opaco que identifica un punto de partida en la colección.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseColumnListResult	Columnas de base de datos recuperadas correctamente.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 No admitidoColumnOrderByProperty: no se admite la propiedad order-by "{0}". Las propiedades permitidas son: {1}. 400 No admitidoColumnSortDirection: no se admite la dirección de ordenación de columna '{0}' . Los valores permitidos son: {1}. 400 UpdateNotAllowedOnPausedDatabase: el usuario intentó realizar una actualización en una base de datos en pausa. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 404 SourceDatabaseNotFound: la base de datos de origen no existe. 404 ResourceDoesNotExist: recurso con el nombre "{0}" no existe. Para continuar, especifique un nombre de recurso válido. 503 DatabaseUnavailable: error en la operación porque la base de datos no está disponible.

Nombre

Tipo

Description

200 OK

DatabaseColumnListResult

Columnas de base de datos recuperadas correctamente.

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 No admitidoColumnOrderByProperty: no se admite la propiedad order-by "{0}". Las propiedades permitidas son: {1}.
400 No admitidoColumnSortDirection: no se admite la dirección de ordenación de columna '{0}' . Los valores permitidos son: {1}.
400 UpdateNotAllowedOnPausedDatabase: el usuario intentó realizar una actualización en una base de datos en pausa.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.
404 SourceDatabaseNotFound: la base de datos de origen no existe.
404 ResourceDoesNotExist: recurso con el nombre "{0}" no existe. Para continuar, especifique un nombre de recurso válido.
503 DatabaseUnavailable: error en la operación porque la base de datos no está disponible.

Ejemplos

Filter managed database columns

List managed database columns

Filter managed database columns

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ColumnDataType	Tipo de datos de columna.
DatabaseColumn	Un recurso de columna de base de datos.
DatabaseColumnListResult	Lista de columnas de base de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
TableTemporalType	Tipo temporal de tabla.

ColumnDataType

Enumeración

Tipo de datos de columna.

Valor	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

Objeto

Un recurso de columna de base de datos.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.columnType	ColumnDataType	Tipo de datos de columna.
properties.isComputed	boolean	Indica si se calcula o no la columna.
properties.memoryOptimized	boolean	Si la columna pertenece o no a una tabla optimizada para memoria.
properties.temporalType	TableTemporalType	Tipo temporal de tabla.
type	string	Tipo de recurso.

DatabaseColumnListResult

Objeto

Lista de columnas de base de datos.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	DatabaseColumn[]	Matriz de resultados.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

TableTemporalType

Enumeración

Tipo temporal de tabla.

Valor	Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable