Managed Database Columns - List By Database

Serviço:: SQL Database

Versão da API:: 2025-01-01

Listar colunas de banco de dados gerenciado

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

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$skiptoken	query		string	Um token opaco que identifica um ponto de partida na coleção.
column	query		string[]
orderBy	query		string[]
schema	query		string[]
table	query		string[]

Respostas

Nome	Tipo	Description
200 OK	DatabaseColumnListResult	Colunas de banco de dados recuperadas com êxito.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 UnsupportedColumnOrderByProperty – A propriedade order-by '{0}' não tem suporte. As propriedades permitidas são: {1}. 400 UnsupportedColumnSortDirection – A direção de classificação da coluna '{0}' não tem suporte. Os valores permitidos são: {1}. 400 UpdateNotAllowedOnPausedDatabase – O usuário tentou executar uma atualização em um banco de dados pausado. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 DatabaseDoesNotExist – O usuário especificou um nome de banco de dados que não existe nesta instância do servidor. 404 SourceDatabaseNotFound – O banco de dados de origem não existe. 404 ResourceDoesNotExist – Recurso com o nome '{0}' não existe. Para continuar, especifique um nome de recurso válido. 503 DatabaseUnavailable – A operação falhou porque o banco de dados não está disponível.

Nome

Tipo

Description

200 OK

DatabaseColumnListResult

Colunas de banco de dados recuperadas com êxito.

Other Status Codes

ErrorResponse

Respostas de erro: ***

400 UnsupportedColumnOrderByProperty – A propriedade order-by '{0}' não tem suporte. As propriedades permitidas são: {1}.
400 UnsupportedColumnSortDirection – A direção de classificação da coluna '{0}' não tem suporte. Os valores permitidos são: {1}.
400 UpdateNotAllowedOnPausedDatabase – O usuário tentou executar uma atualização em um banco de dados pausado.
404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado
404 DatabaseDoesNotExist – O usuário especificou um nome de banco de dados que não existe nesta instância do servidor.
404 SourceDatabaseNotFound – O banco de dados de origem não existe.
404 ResourceDoesNotExist – Recurso com o nome '{0}' não existe. Para continuar, especifique um nome de recurso válido.
503 DatabaseUnavailable – A operação falhou porque o banco de dados não está disponível.

Exemplos

Filter managed database columns

List managed database columns

Filter managed database columns

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
ColumnDataType	O tipo de dados de coluna.
DatabaseColumn	Um recurso de coluna de banco de dados.
DatabaseColumnListResult	Uma lista de colunas de banco de dados.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
TableTemporalType	O tipo temporal da tabela.

ColumnDataType

Enumeração

O tipo de dados de coluna.

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

Um recurso de coluna de banco de dados.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.columnType	ColumnDataType	O tipo de dados de coluna.
properties.isComputed	boolean	Se a coluna é computada ou não.
properties.memoryOptimized	boolean	Se a coluna pertence ou não a uma tabela com otimização de memória.
properties.temporalType	TableTemporalType	O tipo temporal da tabela.
type	string	Tipo de recurso.

DatabaseColumnListResult

Objeto

Uma lista de colunas de banco de dados.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	DatabaseColumn[]	Matriz de resultados.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

TableTemporalType

Enumeração

O tipo temporal da tabela.

Valor	Description
NonTemporalTable
HistoryTable
SystemVersionedTemporalTable