Managed Database Columns - List By Database

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-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=2021-11-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=2021-11-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 por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
subscriptionId	path	True	string	A ID de 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		Respostas de erro: *** 400 UnsupportedColumnOrderByProperty – não há suporte para a propriedade order-by '{0}'. As propriedades permitidas são: {1}. 400 UnsupportedColumnSortDirection - Não há suporte para a direção de classificação de coluna '{0}'. Os valores permitidos são: {1}. 400 UpdateNotAllowedOnPausedDatabase - O usuário tentou executar uma atualização em um banco de dados em pausa. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 SourceDatabaseNotFound - O banco de dados de origem não existe. 404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância de servidor. 404 ResourceDoesNotExist - O 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

Respostas de erro: ***

400 UnsupportedColumnOrderByProperty – não há suporte para a propriedade order-by '{0}'. As propriedades permitidas são: {1}.
400 UnsupportedColumnSortDirection - Não há suporte para a direção de classificação de coluna '{0}'. Os valores permitidos são: {1}.
400 UpdateNotAllowedOnPausedDatabase - O usuário tentou executar uma atualização em um banco de dados em pausa.
404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado
404 SourceDatabaseNotFound - O banco de dados de origem não existe.
404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância de servidor.
404 ResourceDoesNotExist - O 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

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=2021-11-01


import java.util.Arrays;

/**
 * Samples for ManagedDatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMax.json
     */
    /**
     * Sample code: Filter managed database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void filterManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", Arrays.asList("dbo"), Arrays.asList("customer", "address"), Arrays.asList("username"),
            Arrays.asList("schema asc", "table", "column desc"), null, 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

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
Java

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


/**
 * Samples for ManagedDatabaseColumns ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedColumnsListByDatabaseMin.json
     */
    /**
     * Sample code: List managed database columns.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedDatabaseColumns(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseColumns().listByDatabase("myRG", "serverName",
            "myDatabase", null, null, null, null, null, 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

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 da coluna.
DatabaseColumn	Um recurso de coluna de banco de dados.
DatabaseColumnListResult	Uma lista de colunas de banco de dados.
TableTemporalType	O tipo temporal da tabela.

ColumnDataType

O tipo de dados da coluna.

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

DatabaseColumn

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

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.

TableTemporalType

O tipo temporal da tabela.

Nome	Tipo	Description
HistoryTable	string
NonTemporalTable	string
SystemVersionedTemporalTable	string

Compartilhar via

Managed Database Columns - List By Database

Parâmetros de URI

Respostas

Exemplos

Filter managed database columns

Solicitação de exemplo

Resposta de exemplo

List managed database columns

Solicitação de exemplo

Resposta de exemplo

Definições

ColumnDataType

DatabaseColumn

DatabaseColumnListResult

TableTemporalType

Recursos adicionais